Set-ADAuthenticationPolicy
Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2
Set-ADAuthenticationPolicy
Modifies an Active Directory Domain Services authentication policy object.
Syntax
Parameter Set: Identity
Set-ADAuthenticationPolicy [-Identity] <ADAuthenticationPolicy> [-Add <Hashtable> ] [-AuthType <ADAuthType> {Negotiate | Basic} ] [-Clear <String[]> ] [-ComputerAllowedToAuthenticateTo <String> ] [-ComputerTGTLifetimeMins <Int32> ] [-Credential <PSCredential> ] [-Description <String> ] [-Enforce <Boolean> ] [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean> ] [-Remove <Hashtable> ] [-Replace <Hashtable> ] [-Server <String> ] [-ServiceAllowedToAuthenticateFrom <String> ] [-ServiceAllowedToAuthenticateTo <String> ] [-ServiceTGTLifetimeMins <Int32> ] [-UserAllowedToAuthenticateFrom <String> ] [-UserAllowedToAuthenticateTo <String> ] [-UserTGTLifetimeMins <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: Instance
Set-ADAuthenticationPolicy -Instance <ADAuthenticationPolicy> [-AuthType <ADAuthType> {Negotiate | Basic} ] [-Credential <PSCredential> ] [-PassThru] [-Server <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-ADAuthenticationPolicy cmdlet modifies the properties of an Active Directory® Domain Services authentication policy. Commonly used attributes of the object can be specified by the parameters of this cmdlet. Property values that are not associated with cmdlet parameters can be modified by using the Add, Replace, Clear and Remove parameters.
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, 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.
Use the Instance parameter to specify an authentication policy object to use as a template for the object being modified. Do not specify both the Instance parameter and the Identity parameter.
Parameters
-Add<Hashtable>
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 Lightweight Directory Access Protocol (LDAP) display name defined for it in the Active Directory Domain Services schema.
Specify the attribute and the value of the attribute in the following format: @{'AttributeLDAPDisplayName'=value}.
To specify multiple values for an attribute, specify a comma separated list the values for the display name. You can specify values for more than one attribute by using semicolons to separate attribute value pairs.
When specifying the Add, Remove, Replace and Clear parameters together, the operations are performed in the following order:
-- Remove
-- Add
-- Replace
-- Clear
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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
The default authentication method is Negotiate. A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.
Aliases |
none |
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.
When specifying the Add, Remove, Replace, and Clear parameters together, the operations are performed in the following order:
-- Remove
-- Add
-- Replace
-- Clear
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
By default, the cmdlet uses the credentials of the currently logged on user unless the cmdlet is run from an Active Directory Domain Services Windows PowerShell provider drive. If you run the cmdlet in a provider drive, the account associated with the drive is the default.
If you specify credentials that do not have permission to perform the task, the cmdlet returns an error.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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".
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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
This parameter can also get this object through the pipeline or you can set this parameter to an object instance.
The cmdlet searches the default naming context or partition to find the object. If the cmdlet finds two or more objects, the cmdlet returns a non-terminating error.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
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.
To get the ADAuthenticationPolicy object to use to update the ADAuthenticationPolicy on which the cmdlet runs, use the Get-ADAuthenticationPolicy cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Specify the attribute and the value of the attribute in the following format: @{'AttributeLDAPDisplayName'=value}.
To specify multiple values for an attribute, specify a comma separated list the values for the display name. You can specify values for more than one attribute by using semicolons to separate attribute value pairs.
When specifying the Add, Remove, Replace and Clear parameters together, the operations are performed in the following order:
-- Remove
-- Add
-- Replace
-- Clear
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Specify the attribute and the value of the attribute in the following format: @{'AttributeLDAPDisplayName'=value}.
To specify multiple values for an attribute, specify a comma separated list the values for the display name. You can specify values for more than one attribute by using semicolons to separate attribute value pairs.
When specifying the Add, Remove, Replace and Clear parameters together, the operations are performed in the following order:
-- Remove
-- Add
-- Replace
-- Clear
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Specify the Active Directory Domain Services instance in one of the following ways:
Domain name values:
-- Fully qualified domain name
-- NetBIOS name
Directory server values:
-- Fully qualified directory server name
-- NetBIOS name
-- Fully qualified directory server name and port
The default value for this parameter is determined by one of the following methods in the order that they are listed:
-- By using the Server value from objects passed through the pipeline
-- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive
-- By using the domain of the computer running Windows PowerShell
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ServiceTGTLifetimeMins<Int32>
Specifies the lifetime in minutes for non-renewable TGTs for service accounts.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UserTGTLifetimeMins<Int32>
Specifies the lifetime in minutes for non-renewable TGTs for user accounts.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
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? |
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.
None or Microsoft.ActiveDirectory.Management.ADAuthenticationPolicy
This cmdlet accepts an authentication policy object.
Outputs
The output type is the type of the objects that the cmdlet emits.
System.Object
Returns one or more objects.
Examples
Example 1: Modify properties of a specified authentication policy
This command modifies the description and the UserTGTLifetimeMins properties of the specified authentication policy.
PS C:\> Set-ADAuthenticationPolicy -Identity AuthenticationPolicy01 -Description "TestDescription" -UserTGTLifetimeMins 45
Example 2: Modify properties of an authentication policy by using an Instance.
This example first gets the authentication policy named AuthenticationPolicy02 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.
PS C:\> $AuthPolicy = Get-ADAuthenticationPolicy -Identity AuthenticationPolicy02
PS C:\> $AuthPolicy.Description = 'testDescription'
PS C:\> $AuthPolicy.UserTGTLifetimeMins = 60
PS C:\> Set-ADAuthenticationPolicy -Instance $AuthPolicy
Example 3: Modify multiple authentication policies
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.
PS C:\> Get-ADAuthenticationPolicy -Filter 'UserTGTLifetimeMins -le 50' | Set-ADAuthenticationPolicy -UserTGTLifetimeMins 60
Example 4: Replace an existing property value
This command replaces the existing description property for AuthenticationPolicy03 with the new description specified by the Replace parameter.
PS C:\> Set-ADAuthenticationPolicy -Identity AuthenticationPolicy03 -Replace @{description="New Description"}