Sync-ADObject

  ActiveDirectory
Module Version:

1.0.0.0

NAME:
Sync-ADObject
DESCRIPTION:

The Sync-ADObject cmdlet replicates a single object between any two domain controllers that have partitions in common. The two domain controllers do not need to
be direct replication partners. It can also be used to populate passwords in a read-only domain controller (RODC) cache.

EXAMPLES:

SYNTAX:

SYNOPSIS:
Replicates a single object between any two domain controllers that have partitions in common.
INPUTS:

Microsoft.ActiveDirectory.Management.ADObject

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.ADOrganizationalUnit

Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy

Microsoft.ActiveDirectory.Management.ADDomain

OUTPUTS:

PARAMETERS:

-AuthType
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

Required? false
Position? named
Default value Microsoft.ActiveDirectory.Management.AuthType.Negotiate
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-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.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Destination
Specifies the identity of the Active Directory server that acts as the destination for synchronizing this data. This parameter works similarly to the
Server parameter as used on the Set-Object cmdlet with some restrictions. It does not allow domain or forest names to be used.

Valid format foes specifying the destination server are the following:

Host name

Example: corp-DC12

Host name and port

Examples: corp-DC12:3268

Fully qualified directory server name and port

Example: corp-DC12.corp.contoso.com:3268

IP address

Examples: 10.0.0.1

IP address and port

Example: 10.0.0.1:3268

Required? true
Position? 3
Default value
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.

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

Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false

-PassThru []
Returns the object once it has been synchronized on the destination server. By default if the PassThru parameter is not specified, this cmdlet does not
generate any output.

Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false

-PasswordOnly []
Populates a read-only domain controller (RODC) password cache with the password of the account specified in the Object parameter. If specified, no other
data is replicated other than the password.

Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false

-Source
Specifies the identity of the Active Directory server that acts as the source for synchronizing this data. This parameter works similarly to the Server
parameter as used on the Set-Object cmdlet with some restrictions. It does not allow domain or forest names to be used.

Valid format foes specifying the source server are the following:

Host name

Example: corp-DC12

Host name and port

Examples: corp-DC12:3268

Fully qualified directory server name and port

Example: corp-DC12.corp.contoso.com:3268

IP address

Examples: 10.0.0.1

IP address and port

Example: 10.0.0.1:3268

Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

LEAVE A COMMENT