Set-ADAuthenticationPolicy
Synopsis
Description
The Identity parameter specifies the Active Directory Domain Services authentication policy to modify. You can specify an authentication policy object by using a distinguished name (DN), a GUID, or a name. You can also use the Identity parameter to specify a variable that contains an authentication policy object, or you can use the pipeline operator to pass an authentication policy object to the Identity parameter. To get an authentication policy object, use the Get-ADAuthenticationPolicy cmdlet.
For more information about how the Instance concept is used in Active Directory Domain Services cmdlets, see about_ActiveDirectory_Instance.
Parameters
-Add
Specifies a list of values to add to an object property. Use this parameter to add one or more values to a property that cannot be modified using a parameter. To identify an attribute, specify the LDAP Display Name defined for it in the Active Directory Domain Services schema.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AuthType <ADAuthType>
Specifies the authentication method to use. The acceptable values for this parameter are:
--Negotiate or 0
--Basic or 1
Required? false
Position? named
Default value Microsoft.ActiveDirectory.Management.AuthType.Negotiate
Accept pipeline input? false
Accept wildcard characters? false
-Clear <String[]>
Specifies an array of object properties that are cleared in the directory. Use this parameter to clear one or more values of a property that cannot be modified using a parameter. To modify an object property, you must specify the LDAP display name. You can modify more than one property by specifying a comma-separated list.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ComputerAllowedToAuthenticateTo <String>
Specifies the security descriptor definition language (SDDL) string of the security descriptor used to determine if the computer can authenticate to this account.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ComputerTGTLifetimeMins <Int32>
Specifies the lifetime in minutes for non-renewable ticket granting tickets (TGTs) for computer accounts.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Credential <PSCredential>
Specifies a user account that has permission to perform the task. 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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
Specifies a description for the object. This parameter sets the value of the description property for the object. The LDAP Display Name (ldapDisplayName) for this property is "description".
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Enforce <Boolean>
Indicates whether the authentication policy is enforced. Specify $True to set the authentication policy to enforced. Specify $False to set the authentication policy to not enforced.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Identity <ADAuthenticationPolicy>
Specifies an Active Directory Domain Services authentication policy object. Specify the authentication policy object in one of the following formats:
--Distinguished Name
--GUID
--Name
Required? true
Position? 0
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Instance <ADAuthenticationPolicy>
Specifies a modified copy of an ADAuthenticationPolicy object to use to update the actual ADAuthenticationPolicy object. When you specify this parameter, any modifications made to the modified copy of the object are also made to the corresponding ADAuthenticationPolicy object. The cmdlet only updates the object properties that have changed. When you specify the Instance parameter, you cannot specify other parameters that set properties on the object.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PassThru <SwitchParameter>
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProtectedFromAccidentalDeletion <Boolean>
Indicates whether to prevent the object from being deleted. When this property is set to true, you cannot delete the corresponding object without changing the value of the property. The acceptable values for this parameter are:
--$False or 0
--$True or 1
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Remove <Hashtable>
Specifies that the cmdlet remove the values of an object property. Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. To remove an object property, you must specify the LDAP display name.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Replace <Hashtable>
Specifies a list of values for an object property that replaces the current values. Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. To modify an object property, you must specify the LDAP display name.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Server <String>
Specifies the Active Directory Domain Services instance to which to connect, 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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ServiceAllowedToAuthenticateFrom <String>
Specifies an access control expression used to determine from which devices the service can authenticate.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ServiceAllowedToAuthenticateTo <String>
Specifies the SDDL string of the security descriptor used to determine if the service can authenticate to this account.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ServiceTGTLifetimeMins <Int32>
Specifies the lifetime in minutes for non-renewable TGTs for service accounts.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UserAllowedToAuthenticateFrom <String>
Specifies an access control expression used to determine from which devices the users can authenticate.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UserAllowedToAuthenticateTo <String>
Specifies the SDDL string of the security descriptor used to determine if the users can authenticate to this account.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UserTGTLifetimeMins <Int32>
Specifies the lifetime in minutes for non-renewable TGTs for user accounts.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm <SwitchParameter>
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf <SwitchParameter>
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? falseSyntax
Set-ADAuthenticationPolicy [-WhatIf] [-Confirm] [-Add <Hashtable>] [-AuthType <ADAuthType>] [-Clear <String[]>] [-ComputerAllowedToAuthenticateTo <String>] [-ComputerTGTLifetimeMins <Int32>] [-Credential <PSCredential>] [-Description <String>] [-Enforce <Boolean>] [-Identity] <ADAuthenticationPolicy> [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Server <String>] [-ServiceAllowedToAuthenticateFrom <String>] [-ServiceAllowedToAuthenticateTo <String>] [-ServiceTGTLifetimeMins <Int32>] [-UserAllowedToAuthenticateFrom <String>] [-UserAllowedToAuthenticateTo <String>] [-UserTGTLifetimeMins <Int32>] [<CommonParameters>]
Set-ADAuthenticationPolicy [-WhatIf] [-Confirm] [-AuthType <ADAuthType>] [-Credential <PSCredential>] -Instance <ADAuthenticationPolicy> [-PassThru] [-Server <String>] [<CommonParameters>]
Modify properties of a specified authentication policy
PS C:> Set-ADAuthenticationPolicy -Identity AuthPolicy01 -Description “testDesc” -UserTGTLifetimeMins 45
This command modifies the description and the UserTGTLifetimeMins properties of the specified authentication policy.
Modify properties of an authentication policy by using an Instance.
PS C:> $authPolicy = Get-ADAuthenticationPolicy -Identity AuthPolicy02
PS C:> $authPolicy.Description = ‘testDescription’
PS C:> $authPolicy.UserTGTLifetimeMins = 60
PS C:> Set-ADAuthenticationPolicy -Instance $authPolicy
This example first gets the authentication policy named AuthPolicy02 by using the Get-ADAuthenticationPolicy cmdlet. The authentication policy object is stored in the variable named $authPolicy.
The next commands modify the properties of the object in the variable, and the final command specifies the Instance parameter to commit the changes to the authentication policy stored in the $authPolicy variable.
Modify multiple authentication policies
PS C:> Get-ADAuthenticationPolicy -Filter ‘UserTGTLifetimeMins -le 50’ | Set-ADAuthenticationPolicy -UserTGTLifetimeMins 60
This command uses the Get-ADAuthenticationPolicy cmdlet with the Filter parameter to get all authentication policies that have the UserTGTLifetimeMins value set below 50 minutes. The pipeline operator then passes the result of the filter to Set-AdAuthenticationPolicy, which sets the new UserTGTLifetimeMins value to 60 minutes.
Replace an existing property value
PS C:> Set-ADAuthenticationPolicy AuthPolicy03 -Replace @{description=”New Description”}
This command replaces the existing description property for AuthPolicy03 with the new description specified by the Replace parameter.
Get-Command Set-ADAuthenticationPolicy
. Get-ADAuthenticationPolicy
. New-ADAuthenticationPolicy
. Remove-ADAuthenticationPolicy
