Get-ADReplicationFailure

Get-ADReplicationFailure

Returns a collection of data describing an Active Directory replication failure.

Syntax

Parameter Set: Target
Get-ADReplicationFailure [-Target] <Object[]> [-AuthType <ADAuthType> ] [-Credential <PSCredential> ] [-EnumeratingServer <String> ] [-Filter <String> ] [ <CommonParameters>]

Parameter Set: Scope
Get-ADReplicationFailure [[-Target] <Object[]> ] [-Scope] <ADScopeType> [-AuthType <ADAuthType> ] [-Credential <PSCredential> ] [-EnumeratingServer <String> ] [-Filter <String> ] [ <CommonParameters>]

Detailed Description

The Get-ADReplicationFailure cmdlet returns all failures currently associated with a given domain controller or Active Directory Lightweight Directory Services (AD LDS) instance. The return object is of type ADReplicationFailure. This cmdlet returns the list of failures in the ADReplicationSummary object for a specific server.

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

-EnumeratingServer<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?

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

-Scope<ADScopeType>

Specifies the type of object used as input by the Target parameter. The following are allowable values to use:

Server

Site

Domain

Forest

Aliases

none

Required?

true

Position?

2

Default Value

None

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Target<Object[]>

Specifies either one or more (using a comma separated list) of Active Directory domain controllers, sites, domains, or forests. It will return results for all the domain controllers that are specified or that are part of the specified container.

Aliases

none

Required?

true

Position?

1

Default Value

DCLocator; Provider: -Server of the connected drive

Accept Pipeline Input?

true (ByValue)

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

    A class structure that contains one or more Active Directory server objects.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.ActiveDirectory.Management.ADReplicationFailure

    A class structure that represents Active Directory replication failure objects.

Examples

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

Description

-----------

Get a collection of data describing an Active Directory replication failure for corp-DC01.

C:\PS>Get-ADReplicationFailure -Target corp-DC01

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

Description

-----------

Get a collection of data describing an Active Directory replication failure from corp-DC01 (same as above).

C:\PS>Get-ADReplicationFailure -Target corp-DC01 -Scope Server

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

Description

-----------

Get a collection of data describing an Active Directory replication failure from corp-DC01 and corp-DC02.

C:\PS>Get-ADReplicationFailure -Target corp-DC01,corp-DC02

-------------------------- EXAMPLE 4 --------------------------

Description

-----------

Get a collection of data describing Active Directory replication failures from all the domain controllers in the site 'NorthAmerica'.

C:\PS>Get-ADReplicationFailure -Target NorthAmerica -Scope Site

-------------------------- EXAMPLE 5 --------------------------

Description

-----------

Get a collection of data describing Active Directory replication failures from all the domain controllers in the domain 'corp.contoso.com'.

C:\PS>Get-ADReplicationFailure -Target "corp.contoso.com" -Scope Domain

-------------------------- EXAMPLE 6 --------------------------

Description

-----------

Get a collection of data describing Active Directory replication failures from all the domain controllers in the forest 'corp.contoso.com'

C:\PS>Get-ADReplicationFailure -Target "corp.contoso.com" -Scope Forest