Skip to main content

Get-EntraConnectSyncObjectReport

SYNOPSIS

Reports the objects of the Microsoft Entra Connect Sync connector spaces: sync rules applied, password sync status and sync or export errors.

SYNTAX

DESCRIPTION

Reads the connector space objects with Get-ADSyncCSObject on the Entra Connect Sync server and returns one row per object: the sync rules applied, the password sync status when asked, the HasSyncError and HasExportError flags and the error texts. By default every object of every Active Directory connector is returned. Use -ErrorsOnly to keep only the objects currently in error, on every connector: they are read with csexport.exe, which filters in the sync engine, so the whole connector space is not listed. The password sync status is read from the object log (Get-ADSyncCSObjectLog, one call per object, slow on a large directory) and is collected only with -IncludePasswordSync. With -GroupByErrorType, the function returns a summary instead: the number of objects per error type, per connector and per error kind (Synchronization or Export). For the health of the sync itself (service, scheduler, last runs, pending exports), use Get-EntraConnectSyncHealth. Must be run on the Entra Connect Sync server (ADSync module) with a member of the ADSyncAdmins group.

EXAMPLES

EXAMPLE 1

Lists every object in synchronization or export error, on all connectors (AD and Entra ID).

EXAMPLE 2

Shows how many objects fail for each error type.

EXAMPLE 3

Shows the rules applied to one user and its last password sync event.

EXAMPLE 4

Exports the user objects in error to a CSV file.

PARAMETERS

-ConnectorName

Name of one or more connectors to read. By default, all connectors of type AD (all connectors with -ErrorsOnly or -GroupByErrorType).

-DistinguishedName

Distinguished name of a single object to read.

-ErrorsOnly

Keeps only the objects currently in import, synchronization or export error, on every connector (AD and Entra ID) unless -ConnectorName is set. Read with csexport.exe (fast), except with -DistinguishedName. Each row adds the on-premises DN, UPN, error dates, retry count and, for a duplicate attribute, the conflicting object (ErrorDetails).

-ExportPath

Path of a CSV file to write the result to. The result is still returned.

-GroupByErrorType

Returns the error count per error type instead of one row per object. Implies -ErrorsOnly.

-IncludePasswordSync

Adds the last password sync status and timestamp of each object, and whether the password sync rule applies. One log query per object: combine with -ErrorsOnly or -DistinguishedName on a large directory.

-ObjectType

Keeps only objects of these types, for example user, group, contact or computer.

-Top

Stops after this number of returned objects.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Requires the ADSync module, installed with Microsoft Entra Connect Sync. Without -ErrorsOnly, the …ErrorType columns hold the first line of the connector space error text (for example permission-issue), the …Error columns the full text. With -ErrorsOnly, the …ErrorType columns hold the error name given by csexport (for example AttributeValueMustBeUnique) and the …Error columns its message. Not documented.