Test-ADServiceAccount

Test-ADServiceAccount

Tests a managed service account from a computer.

Syntax

Parameter Set: Identity
Test-ADServiceAccount [-Identity] <ADServiceAccount> [-AuthType <ADAuthType> ] [ <CommonParameters>]

Detailed Description

The Test-ADServiceAccount cmdlet tests a managed service account (MSA) from a local computer.

The Identity parameter specifies the Active Directory MSA account to test. You can identify a MSA by its distinguished name (DN), GUID, security identifier (SID), or Security Accounts Manager (SAM) account name. You can also set the parameter to a MSA object variable, such as $<localMSA> or pass a MSA object through the pipeline to the Identity parameter. For example, you can use the Get-ADServiceAccount to get a MSA object and then pass that object through the pipeline to the Test-ADServiceAccount cmdlet.

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

-Identity<ADServiceAccount>

Specifies an Active Directory managed service account 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=MyServiceMSA,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com

GUID (objectGUID)

Example: 599c3d2e-f72d-4d20-8a88-030d99495f20

Security Identifier (objectSid)

Example: S-1-5-21-3165297888-301567370-576410423-1103

SAM account name (sAMAccountName)

Example: MyServiceMSA

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.

This example shows how to set the parameter to a distinguished name.

-Identity "CN=MyServiceMSA,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com"

This example shows how to set this parameter to a user object instance named "userInstance".

-Identity $userInstance

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

• None or Microsoft.ActiveDirectory.Management.ADServiceAccount

  A managed service account object is received by the Identity parameter.

Outputs

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

• None

Examples

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

Description

-----------

Tests that the specified service account ("MSA1") is ready for use (it is able be authenticated and access the domain using its currently configured credentials) from the local computer.

C:\PS>Test-ADServiceAccount -Identity MSA1

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

Description

-----------

Test results returned if MsaInfoCannotInstall

C:\PS>Test-ADServiceAccount -Identity MSA1

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

Description

-----------

Test returns MsaInfoCanInstall

C:\PS>Test-ADServiceAccount -Identity MSA1