< Back
Set-ADFineGrainedPasswordPolicy
Post
NAME Set-ADFineGrainedPasswordPolicy
SYNOPSIS
Modifies an Active Directory fine grained password policy.
SYNTAX
Set-ADFineGrainedPasswordPolicy [-Identity] <ADFineGrainedPasswordPolicy> [-Add <Hashtable>] [-AuthType {Negotiate
| Basic}] [-Clear <String[]>] [-ComplexityEnabled <Boolean>] [-Credential <PSCredential>] [-Description <String>]
[-DisplayName <String>] [-LockoutDuration <TimeSpan>] [-LockoutObservationWindow <TimeSpan>] [-LockoutThreshold
<Int32>] [-MaxPasswordAge <TimeSpan>] [-MinPasswordAge <TimeSpan>] [-MinPasswordLength <Int32>] [-PassThru]
[-PasswordHistoryCount <Int32>] [-Precedence <Int32>] [-ProtectedFromAccidentalDeletion <Boolean>] [-Remove
<Hashtable>] [-Replace <Hashtable>] [-ReversibleEncryptionEnabled <Boolean>] [-Server <String>] [-Confirm]
[-WhatIf] [<CommonParameters>]
Set-ADFineGrainedPasswordPolicy [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>] [-PassThru] [-Server
<String>] -Instance <ADFineGrainedPasswordPolicy> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-ADFineGrainedPasswordPolicy cmdlet modifies the properties of an Active Directory fine grained password
policy. You can modify commonly used property values by using the cmdlet parameters. 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 fine grained password policy to modify. You can identify a
fine grained password policy by its distinguished name (DN), GUID or name. You can also set the Identity parameter
to an object variable such as $<localFineGrainedPasswordPolicyObject>, or you can pass an object through the
pipeline to the Identity parameter. For example, you can use the Get-ADFineGrainedPasswordPolicy cmdlet to
retrieve a fine grained password policy object and then pass the object through the pipeline to the
Set-ADFineGrainedPasswordPolicy cmdlet.
The Instance parameter provides a way to update a fine grained password policy object by applying the changes made
to a copy of the object. When you set the Instance parameter to a copy of an Active Directory fine grained
password policy object that has been modified, the Set-ADFineGrainedPasswordPolicy cmdlet makes the same changes
to the original fine grained password policy object. To get a copy of the object to modify, use the
Get-ADFineGrainedPasswordPolicy object. The Identity parameter is not allowed when you use the Instance parameter.
For more information about the Instance parameter, see the Instance parameter description. For more information
about how the Instance concept is used in Active Directory cmdlets, see about_ActiveDirectory_Instance
The following examples show how to modify the Precedence property of a fine grained password policy object by
using three methods:
-By specifying the Identity and the Precedence parameters
-By passing a fine grained password policy object through the pipeline and specifying the Precedence parameter
-By specifying the Instance parameter.
Method 1: Modify the Precedence property for the Level3Policyfine grained password policy by using the Identity
and Precedence parameters.
Set-ADFineGrainedPasswordPolicy -Identity "Level3Policy" -Precedence 150
Method 2: Modify the Precedence property for the Level3Policyfine grained password policy by passing the
Level3Policyfine grained password policy through the pipeline and specifying the Precedence parameter.
Get-ADFineGrainedPasswordPolicy -Identity "Level3Policy"| Set-ADFineGrainedPasswordPolicy -Precedence 150
Method 3: Modify the Precedence property for the Level3Policy fine grained password policy by using the Windows
PowerShell command line to modify a local instance of the Level3Policyfine grained password policy. Then set the
Instance parameter to the local instance.
$fineGrainedPasswordPolicy = Get-ADFineGrainedPasswordPolicy Level3Policy
$fineGrainedPasswordPolicy.Precedence = 150
Set-ADFineGrainedPasswordPolicy -Instance $fineGrainedPasswordPolicy
PARAMETERS
-Add <Hashtable>
Specifies 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 cmdlet parameter. To modify an object property, you must use the LDAP display name.
You can specify multiple values to a property by specifying a comma-separated list of values and more than one
property by separating them using a semicolon.. The format for this parameter is
-Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...;
AttributeNLDAPDisplayName=value1, value2, ...}
For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and
"555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value
"555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as
follows.
-Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove
@{otherTelephone='555-222-2222'}
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-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
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 will be cleared in the directory. Use this parameter to clear one
or more values of a property that cannot be modified using a cmdlet parameter. To modify an object property,
you must use the LDAP display name. You can modify more than one property by specifying a comma-separated
list. The format for this parameter is
-Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName
For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name
'otherTelephone') set the Clear parameter as follows.
-Clear otherTelephone
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ComplexityEnabled <Boolean>
Specifies whether password complexity is enabled for the password policy. If enabled, the password must
contain two of the following three character types:
Uppercase characters (A, B, C, D, E, ...)
Lowercase characters (a, b, c, d, e, ...)
Numerals (0, 1, 2, 3, ...)
This parameter sets the ComplexityEnabled property of a password policy.
Possible values for this parameter include:
$false or 0 - Disables password complexity
$true or 1 - Enables password complexity
The following example shows how to set this parameter to true.
-ComplexityEnabled $true
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Credential <PSCredential>
Specifies the user account credentials to use to perform this task. The default credentials are the
credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell
provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the
default.
To specify this parameter, you can type a user name, such as "User1" or "Domain01\\User01" or you can specify a
PSCredential object. If you specify a user name for this parameter, the cmdlet prompts for a password.
You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. You can
then set the Credential parameter to the PSCredential object The following example shows how to create
credentials.
$AdminCredentials = Get-Credential "Domain01\\User01"
The following shows how to set the Credential parameter to these credentials.
-Credential $AdminCredentials
If the acting credentials do not have directory-level permission to perform the task, Active Directory
PowerShell returns a terminating error.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
Specifies a description of the object. This parameter sets the value of the Description property for the
object. The LDAP Display Name (ldapDisplayName) for this property is "description".
The following example shows how to set this parameter to a sample description.
-Description "Description of the object"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DisplayName <String>
Specifies the display name of the object. This parameter sets the DisplayName property of the object. The LDAP
Display Name (ldapDisplayName) for this property is "displayName".
The following example shows how to set this parameter.
-DisplayName "Sara Davis Laptop"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Identity <ADFineGrainedPasswordPolicy>
Specifies an Active Directory fine-grained password policy object by providing one of the following property
values. The identifier in parentheses is the LDAP display name for the attribute.
Distinguished Name (distinguishedName)
Example: CN=Strict Password Policy,CN=Password Settings Container,CN=System,DC=corp,DC=contoso,DC=com
GUID (objectGUID)
Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
Name (name)
Example: PasswordPolicyLevel1
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 a fine-grained
password policy object instance.
This example shows how to set the parameter to a distinguished name.
-Identity "CN=Strict Password Policy,CN=Password Settings Container,CN=System,DC=corp,DC=contoso,DC=com"
This example shows how to set this parameter to a fine-grained password policy object instance named
"fineGrainedPasswordPolicyInstance".
-Identity $fineGrainedPasswordPolicyInstance
Required? true
Position? 1
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Instance <ADFineGrainedPasswordPolicy>
Specifies a modified copy of a fine-grained password policy object to use to update the actual Active
Directory fine-grained password policy object. When this parameter is used, any modifications made to the
modified copy of the object are also made to the corresponding Active Directory object. The cmdlet only
updates the object properties that have changed.
The Instance parameter can only update fine-grained password policy objects that have been retrieved by using
the Get-ADFineGrainedPasswordPolicy cmdlet. When you specify the Instance parameter, you cannot specify other
parameters that set properties on the object.
The following is an example of how to use the Get-ADFineGrainedPasswordPolicy cmdlet to retrieve an instance
of the ADFineGrainedPasswordPolicy object. The object is modified by using the Windows PowerShell command
line. Then the Set-ADFineGrainedPasswordPolicy cmdlet saves the changes to the Active Directory object.
Step 1: Retrieve a local instance of the object.
$fineGrainedPasswordPolicyInstance = Get-ADFineGrainedPasswordPolicy -Identity PasswordPolicyLevel2
Step 2: Modify one or more properties of the object instance.
$fineGrainedPasswordPolicyInstance.Precedence = 250
Step3: Save your changes to PasswordPolicyLevel2.
Set-ADFineGrainedPasswordPolicy -Instance $fineGrainedPasswordPolicyInstance
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LockoutDuration <TimeSpan>
Specifies the length of time that an account is locked after the number of failed login attempts exceeds the
lockout threshold. You cannot login to an account that is locked until the lockout duration time period has
expired. This parameter sets the lockoutDuration property of a password policy object. The LDAP display name
(ldapDisplayName) of this property is "msDS-LockoutDuration".
The lockout duration must be greater than or equal to the lockout observation time for a password policy. Use
the LockOutObservationWindow parameter to set the lockout observation time.
Specify the lockout duration time interval in the following format.
[-]D.H:M:S.F
where:
D = Days (0 to 10675199)
H = Hours (0 to 23)
M = Minutes (0 to 59)
S = Seconds (0 to 59)
F= Fractions of a second (0 to 9999999)
The following examples show how to set this parameter.
Set the time to 2 days
-LockoutDuration "2"
Set the time to 4 hours
-LockoutDuration "4:00"
Set the time to 5 minutes
-LockoutDuration "0:5"
Set the time to 45 seconds
LockoutDuration "0:0:45"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LockoutObservationWindow <TimeSpan>
Specifies the maximum time interval between two unsuccessful login attempts before the number of unsuccessful
login attempts is reset to 0. An account is locked when the number of unsuccessful login attempts exceeds the
password policy lockout threshold. This parameter sets the lockoutObservationWindow property of a password
policy object. The LDAP Display Name (ldapDisplayName) of this property is "msDS-lockoutObservationWindow".
The lockout observation window must be smaller than or equal to the lockout duration for a password policy.
Use the LockoutDuration parameter to set the lockout duration time.
Specify the time interval in the following format.
[-]D:H:M:S.F
where:
D = Days (0 to 10675199)
H = Hours (0 to 23)
M = Minutes (0 to 59)
S = Seconds (0 to 59)
F= Fractions of a second (0 to 9999999)
Note: Time values must be between the following values: 0:0:0:0.0 and 10675199:02:48:05.4775807.
The following examples show how to set this parameter.
Set the time to 2 days
-LockoutObservationWindow "2"
Set the time to 4 hours
-LockoutObservationWindow "4:00"
Set the time to 5 minutes
-LockoutObservationWindow "0:5"
Set the time to 45 seconds
-LockoutObservationWindow "0:0:45"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LockoutThreshold <Int32>
Specifies the number of unsuccessful login attempts that are permitted before an account is locked out. This
number increases when the time between unsuccessful login attempts is less than the time specified for the
lockout observation time window. This parameter sets the LockoutThreshold property of a password policy.
The following example shows how to set the lockout threshold to 3 login attempts.
-LockoutThreshold 3
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MaxPasswordAge <TimeSpan>
Specifies the maximum length of time that you can have the same password. After this time period, the password
expires and you must create a new one.
This parameter sets the maxPasswordAge property of a password policy. The LDAP Display Name (ldapDisplayName)
for this property is "maxPwdAge".
Specify the time interval in the following format.
[-]D.H:M:S.F
where:
[-] = Specifies a negative time interval
D = Days (0 to 10675199)
H = Hours (0 to 23)
M = Minutes (0 to 59)
S = Seconds (0 to 59)
F= Fractions of a second (0 to 9999999)
Note: Time values must be between the following values: -10675199:02:48:05.4775808 and
10675199:02:48:05.4775807.
The following examples show how to set this parameter.
Set the time span to 2 days
MaxPasswordAge "2"
Set the time span to the previous 2 days
MaxPasswordAge "-2"
Set the time span to 4 hours
MaxPasswordAge "4:00"
Set the time span to 5 minutes
MaxPasswordAge "0:5"
Set the time span to 45 seconds
MaxPasswordAge "0:0:45"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MinPasswordAge <TimeSpan>
Specifies the minimum length of time before you can change a password.
This parameter sets the minPasswordAge property of a password policy. The LDAP Display Name (ldapDisplayName)
for this property is "minPwdAge".
Specify the time interval in the following format.
[-]D.H:M:S.F
where:
[-] = Specifies a negative time interval
D = Days (0 to 10675199)
H = Hours (0 to 23)
M = Minutes (0 to 59)
S = Seconds (0 to 59)
F= Fractions of a second (0 to 9999999)
Note: Time values must be between the following values: -10675199:02:48:05.4775808 and
10675199:02:48:05.4775807.
The following examples show how to set this parameter.
Set the time span to 2 days
-MinPasswordAge "2"
Set the time span to 4 hours
-MinPasswordAge "4:00"
Set the time span to 5 minutes
-MinPasswordAge "0:5"
Set the time span to 45 seconds
-MinPasswordAge "0:0:45"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MinPasswordLength <Int32>
Specifies the minimum number of characters that a password must contain. This parameter sets the
MinPasswordLength property of the password policy.
The following example shows how to set this parameter.
-MinPasswordLength 15
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns the new or modified object. By default (i.e. if -PassThru is not specified), this cmdlet does not
generate any output.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PasswordHistoryCount <Int32>
Specifies the number of previous passwords to save. A user cannot reuse a password in the list of saved
passwords. This parameter sets the PasswordHistoryCount property for a password policy.
The following example shows how to set this parameter to save 10 previous passwords.
-PasswordHistoryCount 10
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Precedence <Int32>
Specifies a value that defines the precedence of a fine-grained password policy among all fine-grained
password policies. This parameter sets the Precedence property for a fine-grained password policy. The LDAP
display name (ldapDisplayName) for this property is "msDS-PasswordSettingsPrecedence".
This value determines which password policy to use when more than one password policy applies to a user or
group. When there is a conflict, the password policy that has the lower Precedence property value has higher
priority. For example, if PasswordPolicy1 has a Precedence property value of 200 and PasswordPolicy2 has a
Precedence property value of 100, PasswordPolicy2 is used.
Typically, password policy precedence values are assigned in multiples of 10 or 100, making it easier to add
policies at a later time. For example, if you set the initial precedence values for your policies to 100 and
200, you can add another policy that has precedence value of 150.
If the specified Precedence parameter is already assigned to another password policy object, the cmdlet
returns a terminating error.
The following example shows how to set this parameter.
-Precedence 100
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProtectedFromAccidentalDeletion <Boolean>
Specifies 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. Possible values for this parameter
include:
$false or 0
$true or 1
The following example shows how to set this parameter to true.
-ProtectedFromAccidentalDeletion $true
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Remove <Hashtable>
Specifies that the cmdlet remove 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 use the
LDAP display name. You can remove more than one property by specifying a semicolon-separated list. The format
for this parameter is
-Remove @{Attribute1LDAPDisplayName=value[]; Attribute2LDAPDisplayName=value[]}
For example, if you want to add the values blue and green and remove the value pink from a property with a
LDAP display name of FavColors, set the Add and Remove parameters as follows.
-Add @{FavColors=Blue,Green} -Remove {FavColors=Pink}
When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the
following sequence:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Replace <Hashtable>
Specifies values for an object property that will replace 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 use the LDAP display name. You can modify more than one property by specifying a
comma-separated list. The format for this parameter is
-Replace @{Attribute1LDAPDisplayName=value[], Attribute2LDAPDisplayName=value[]}
For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for
Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows.
-Replace @{otherTelephone='555-222-2222', '555-222-1111'}
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ReversibleEncryptionEnabled <Boolean>
Specifies whether the directory must store passwords using reversible encryption. This parameter sets the
ReversibleEncryption property for a password policy. Possible values for this parameter include the following:
$false or 0
$true or 1
The following example shows how to set this parameter to true.
-ReversibleEncryptionEnabled $true
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Server <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 Powershell.
The following example shows how to specify a full qualified domain name as the parameter value.
-Server "corp.contoso.com"
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? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None or Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy
A fine grained password policy object is received by the Identity parameter.
A fine grained password policy object that was retrieved by using the Get-ADFineGrainedPasswordPolicy cmdlet
and then modified is received by the Instance parameter.
OUTPUTS
None or Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy
Returns the modified fine grained password policy object when the PassThru parameter is specified. By default,
this cmdlet does not generate any output.
NOTES
This cmdlet does not work with AD LDS.
This cmdlet does not work with an Active Directory Snapshot.
This cmdlet does not work with a read-only domain controller.
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>Set-ADFineGrainedPasswordPolicy MyPolicy -Precedence 100 -LockoutDuration 00:40:00 -LockoutObservationWindow
00:20:00 -ComplexityEnabled $true -ReversibleEncryptionEnabled $false -MinPasswordLength 12
Description
-----------
Update the Precedence, LockoutDuration, LockoutObservationWindow, ComplexityEnabled, ReversibleEncryptionEnabled,
and MinPasswordLength properties on the FineGrainedPasswordPolicy object with name MyPolicy.
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>Set-ADFineGrainedPasswordPolicy 'CN=MyPolicy,CN=Password Settings Container,CN=System,DC=FABRIKAM,DC=COM'
-MinPasswordLength 12
Description
-----------
Set the MinPasswordLength property on the FineGrainedPasswordPolicy object with DistinguishedName
CN=MyPolicy,CN=Password Settings Container,CN=System,DC=FABRIKAM,DC=COM.
-------------------------- EXAMPLE 3 --------------------------
C:\\PS>$fgpp = Get-ADFineGrainedPasswordPolicy MyPolicy
$fgpp.LockoutObservationWindow = [TimeSpan]::Parse("0.00:15:00")
$fgpp.LockoutThreshold = 10
$fgpp.MinPasswordLength = 8
$fgpp.PasswordHistoryCount = 24
Set-ADFineGrainedPasswordPolicy -Instance $fgpp
Description
-----------
Get the FineGrainedPasswordPolicy object with name MyPolicy, Update a set of properties on the object and then
write the modifications back to the directory using the instance parameter.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291118
Get-ADFineGrainedPasswordPolicy
New-ADFineGrainedPasswordPolicy
Remove-ADFineGrainedPasswordPolicy
SYNOPSIS
Modifies an Active Directory fine grained password policy.
SYNTAX
Set-ADFineGrainedPasswordPolicy [-Identity] <ADFineGrainedPasswordPolicy> [-Add <Hashtable>] [-AuthType {Negotiate
| Basic}] [-Clear <String[]>] [-ComplexityEnabled <Boolean>] [-Credential <PSCredential>] [-Description <String>]
[-DisplayName <String>] [-LockoutDuration <TimeSpan>] [-LockoutObservationWindow <TimeSpan>] [-LockoutThreshold
<Int32>] [-MaxPasswordAge <TimeSpan>] [-MinPasswordAge <TimeSpan>] [-MinPasswordLength <Int32>] [-PassThru]
[-PasswordHistoryCount <Int32>] [-Precedence <Int32>] [-ProtectedFromAccidentalDeletion <Boolean>] [-Remove
<Hashtable>] [-Replace <Hashtable>] [-ReversibleEncryptionEnabled <Boolean>] [-Server <String>] [-Confirm]
[-WhatIf] [<CommonParameters>]
Set-ADFineGrainedPasswordPolicy [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>] [-PassThru] [-Server
<String>] -Instance <ADFineGrainedPasswordPolicy> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-ADFineGrainedPasswordPolicy cmdlet modifies the properties of an Active Directory fine grained password
policy. You can modify commonly used property values by using the cmdlet parameters. 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 fine grained password policy to modify. You can identify a
fine grained password policy by its distinguished name (DN), GUID or name. You can also set the Identity parameter
to an object variable such as $<localFineGrainedPasswordPolicyObject>, or you can pass an object through the
pipeline to the Identity parameter. For example, you can use the Get-ADFineGrainedPasswordPolicy cmdlet to
retrieve a fine grained password policy object and then pass the object through the pipeline to the
Set-ADFineGrainedPasswordPolicy cmdlet.
The Instance parameter provides a way to update a fine grained password policy object by applying the changes made
to a copy of the object. When you set the Instance parameter to a copy of an Active Directory fine grained
password policy object that has been modified, the Set-ADFineGrainedPasswordPolicy cmdlet makes the same changes
to the original fine grained password policy object. To get a copy of the object to modify, use the
Get-ADFineGrainedPasswordPolicy object. The Identity parameter is not allowed when you use the Instance parameter.
For more information about the Instance parameter, see the Instance parameter description. For more information
about how the Instance concept is used in Active Directory cmdlets, see about_ActiveDirectory_Instance
The following examples show how to modify the Precedence property of a fine grained password policy object by
using three methods:
-By specifying the Identity and the Precedence parameters
-By passing a fine grained password policy object through the pipeline and specifying the Precedence parameter
-By specifying the Instance parameter.
Method 1: Modify the Precedence property for the Level3Policyfine grained password policy by using the Identity
and Precedence parameters.
Set-ADFineGrainedPasswordPolicy -Identity "Level3Policy" -Precedence 150
Method 2: Modify the Precedence property for the Level3Policyfine grained password policy by passing the
Level3Policyfine grained password policy through the pipeline and specifying the Precedence parameter.
Get-ADFineGrainedPasswordPolicy -Identity "Level3Policy"| Set-ADFineGrainedPasswordPolicy -Precedence 150
Method 3: Modify the Precedence property for the Level3Policy fine grained password policy by using the Windows
PowerShell command line to modify a local instance of the Level3Policyfine grained password policy. Then set the
Instance parameter to the local instance.
$fineGrainedPasswordPolicy = Get-ADFineGrainedPasswordPolicy Level3Policy
$fineGrainedPasswordPolicy.Precedence = 150
Set-ADFineGrainedPasswordPolicy -Instance $fineGrainedPasswordPolicy
PARAMETERS
-Add <Hashtable>
Specifies 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 cmdlet parameter. To modify an object property, you must use the LDAP display name.
You can specify multiple values to a property by specifying a comma-separated list of values and more than one
property by separating them using a semicolon.. The format for this parameter is
-Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...;
AttributeNLDAPDisplayName=value1, value2, ...}
For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and
"555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value
"555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as
follows.
-Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove
@{otherTelephone='555-222-2222'}
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-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
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 will be cleared in the directory. Use this parameter to clear one
or more values of a property that cannot be modified using a cmdlet parameter. To modify an object property,
you must use the LDAP display name. You can modify more than one property by specifying a comma-separated
list. The format for this parameter is
-Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName
For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name
'otherTelephone') set the Clear parameter as follows.
-Clear otherTelephone
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ComplexityEnabled <Boolean>
Specifies whether password complexity is enabled for the password policy. If enabled, the password must
contain two of the following three character types:
Uppercase characters (A, B, C, D, E, ...)
Lowercase characters (a, b, c, d, e, ...)
Numerals (0, 1, 2, 3, ...)
This parameter sets the ComplexityEnabled property of a password policy.
Possible values for this parameter include:
$false or 0 - Disables password complexity
$true or 1 - Enables password complexity
The following example shows how to set this parameter to true.
-ComplexityEnabled $true
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Credential <PSCredential>
Specifies the user account credentials to use to perform this task. The default credentials are the
credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell
provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the
default.
To specify this parameter, you can type a user name, such as "User1" or "Domain01\\User01" or you can specify a
PSCredential object. If you specify a user name for this parameter, the cmdlet prompts for a password.
You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. You can
then set the Credential parameter to the PSCredential object The following example shows how to create
credentials.
$AdminCredentials = Get-Credential "Domain01\\User01"
The following shows how to set the Credential parameter to these credentials.
-Credential $AdminCredentials
If the acting credentials do not have directory-level permission to perform the task, Active Directory
PowerShell returns a terminating error.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
Specifies a description of the object. This parameter sets the value of the Description property for the
object. The LDAP Display Name (ldapDisplayName) for this property is "description".
The following example shows how to set this parameter to a sample description.
-Description "Description of the object"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DisplayName <String>
Specifies the display name of the object. This parameter sets the DisplayName property of the object. The LDAP
Display Name (ldapDisplayName) for this property is "displayName".
The following example shows how to set this parameter.
-DisplayName "Sara Davis Laptop"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Identity <ADFineGrainedPasswordPolicy>
Specifies an Active Directory fine-grained password policy object by providing one of the following property
values. The identifier in parentheses is the LDAP display name for the attribute.
Distinguished Name (distinguishedName)
Example: CN=Strict Password Policy,CN=Password Settings Container,CN=System,DC=corp,DC=contoso,DC=com
GUID (objectGUID)
Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
Name (name)
Example: PasswordPolicyLevel1
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 a fine-grained
password policy object instance.
This example shows how to set the parameter to a distinguished name.
-Identity "CN=Strict Password Policy,CN=Password Settings Container,CN=System,DC=corp,DC=contoso,DC=com"
This example shows how to set this parameter to a fine-grained password policy object instance named
"fineGrainedPasswordPolicyInstance".
-Identity $fineGrainedPasswordPolicyInstance
Required? true
Position? 1
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Instance <ADFineGrainedPasswordPolicy>
Specifies a modified copy of a fine-grained password policy object to use to update the actual Active
Directory fine-grained password policy object. When this parameter is used, any modifications made to the
modified copy of the object are also made to the corresponding Active Directory object. The cmdlet only
updates the object properties that have changed.
The Instance parameter can only update fine-grained password policy objects that have been retrieved by using
the Get-ADFineGrainedPasswordPolicy cmdlet. When you specify the Instance parameter, you cannot specify other
parameters that set properties on the object.
The following is an example of how to use the Get-ADFineGrainedPasswordPolicy cmdlet to retrieve an instance
of the ADFineGrainedPasswordPolicy object. The object is modified by using the Windows PowerShell command
line. Then the Set-ADFineGrainedPasswordPolicy cmdlet saves the changes to the Active Directory object.
Step 1: Retrieve a local instance of the object.
$fineGrainedPasswordPolicyInstance = Get-ADFineGrainedPasswordPolicy -Identity PasswordPolicyLevel2
Step 2: Modify one or more properties of the object instance.
$fineGrainedPasswordPolicyInstance.Precedence = 250
Step3: Save your changes to PasswordPolicyLevel2.
Set-ADFineGrainedPasswordPolicy -Instance $fineGrainedPasswordPolicyInstance
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LockoutDuration <TimeSpan>
Specifies the length of time that an account is locked after the number of failed login attempts exceeds the
lockout threshold. You cannot login to an account that is locked until the lockout duration time period has
expired. This parameter sets the lockoutDuration property of a password policy object. The LDAP display name
(ldapDisplayName) of this property is "msDS-LockoutDuration".
The lockout duration must be greater than or equal to the lockout observation time for a password policy. Use
the LockOutObservationWindow parameter to set the lockout observation time.
Specify the lockout duration time interval in the following format.
[-]D.H:M:S.F
where:
D = Days (0 to 10675199)
H = Hours (0 to 23)
M = Minutes (0 to 59)
S = Seconds (0 to 59)
F= Fractions of a second (0 to 9999999)
The following examples show how to set this parameter.
Set the time to 2 days
-LockoutDuration "2"
Set the time to 4 hours
-LockoutDuration "4:00"
Set the time to 5 minutes
-LockoutDuration "0:5"
Set the time to 45 seconds
LockoutDuration "0:0:45"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LockoutObservationWindow <TimeSpan>
Specifies the maximum time interval between two unsuccessful login attempts before the number of unsuccessful
login attempts is reset to 0. An account is locked when the number of unsuccessful login attempts exceeds the
password policy lockout threshold. This parameter sets the lockoutObservationWindow property of a password
policy object. The LDAP Display Name (ldapDisplayName) of this property is "msDS-lockoutObservationWindow".
The lockout observation window must be smaller than or equal to the lockout duration for a password policy.
Use the LockoutDuration parameter to set the lockout duration time.
Specify the time interval in the following format.
[-]D:H:M:S.F
where:
D = Days (0 to 10675199)
H = Hours (0 to 23)
M = Minutes (0 to 59)
S = Seconds (0 to 59)
F= Fractions of a second (0 to 9999999)
Note: Time values must be between the following values: 0:0:0:0.0 and 10675199:02:48:05.4775807.
The following examples show how to set this parameter.
Set the time to 2 days
-LockoutObservationWindow "2"
Set the time to 4 hours
-LockoutObservationWindow "4:00"
Set the time to 5 minutes
-LockoutObservationWindow "0:5"
Set the time to 45 seconds
-LockoutObservationWindow "0:0:45"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LockoutThreshold <Int32>
Specifies the number of unsuccessful login attempts that are permitted before an account is locked out. This
number increases when the time between unsuccessful login attempts is less than the time specified for the
lockout observation time window. This parameter sets the LockoutThreshold property of a password policy.
The following example shows how to set the lockout threshold to 3 login attempts.
-LockoutThreshold 3
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MaxPasswordAge <TimeSpan>
Specifies the maximum length of time that you can have the same password. After this time period, the password
expires and you must create a new one.
This parameter sets the maxPasswordAge property of a password policy. The LDAP Display Name (ldapDisplayName)
for this property is "maxPwdAge".
Specify the time interval in the following format.
[-]D.H:M:S.F
where:
[-] = Specifies a negative time interval
D = Days (0 to 10675199)
H = Hours (0 to 23)
M = Minutes (0 to 59)
S = Seconds (0 to 59)
F= Fractions of a second (0 to 9999999)
Note: Time values must be between the following values: -10675199:02:48:05.4775808 and
10675199:02:48:05.4775807.
The following examples show how to set this parameter.
Set the time span to 2 days
MaxPasswordAge "2"
Set the time span to the previous 2 days
MaxPasswordAge "-2"
Set the time span to 4 hours
MaxPasswordAge "4:00"
Set the time span to 5 minutes
MaxPasswordAge "0:5"
Set the time span to 45 seconds
MaxPasswordAge "0:0:45"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MinPasswordAge <TimeSpan>
Specifies the minimum length of time before you can change a password.
This parameter sets the minPasswordAge property of a password policy. The LDAP Display Name (ldapDisplayName)
for this property is "minPwdAge".
Specify the time interval in the following format.
[-]D.H:M:S.F
where:
[-] = Specifies a negative time interval
D = Days (0 to 10675199)
H = Hours (0 to 23)
M = Minutes (0 to 59)
S = Seconds (0 to 59)
F= Fractions of a second (0 to 9999999)
Note: Time values must be between the following values: -10675199:02:48:05.4775808 and
10675199:02:48:05.4775807.
The following examples show how to set this parameter.
Set the time span to 2 days
-MinPasswordAge "2"
Set the time span to 4 hours
-MinPasswordAge "4:00"
Set the time span to 5 minutes
-MinPasswordAge "0:5"
Set the time span to 45 seconds
-MinPasswordAge "0:0:45"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MinPasswordLength <Int32>
Specifies the minimum number of characters that a password must contain. This parameter sets the
MinPasswordLength property of the password policy.
The following example shows how to set this parameter.
-MinPasswordLength 15
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns the new or modified object. By default (i.e. if -PassThru is not specified), this cmdlet does not
generate any output.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PasswordHistoryCount <Int32>
Specifies the number of previous passwords to save. A user cannot reuse a password in the list of saved
passwords. This parameter sets the PasswordHistoryCount property for a password policy.
The following example shows how to set this parameter to save 10 previous passwords.
-PasswordHistoryCount 10
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Precedence <Int32>
Specifies a value that defines the precedence of a fine-grained password policy among all fine-grained
password policies. This parameter sets the Precedence property for a fine-grained password policy. The LDAP
display name (ldapDisplayName) for this property is "msDS-PasswordSettingsPrecedence".
This value determines which password policy to use when more than one password policy applies to a user or
group. When there is a conflict, the password policy that has the lower Precedence property value has higher
priority. For example, if PasswordPolicy1 has a Precedence property value of 200 and PasswordPolicy2 has a
Precedence property value of 100, PasswordPolicy2 is used.
Typically, password policy precedence values are assigned in multiples of 10 or 100, making it easier to add
policies at a later time. For example, if you set the initial precedence values for your policies to 100 and
200, you can add another policy that has precedence value of 150.
If the specified Precedence parameter is already assigned to another password policy object, the cmdlet
returns a terminating error.
The following example shows how to set this parameter.
-Precedence 100
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProtectedFromAccidentalDeletion <Boolean>
Specifies 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. Possible values for this parameter
include:
$false or 0
$true or 1
The following example shows how to set this parameter to true.
-ProtectedFromAccidentalDeletion $true
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Remove <Hashtable>
Specifies that the cmdlet remove 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 use the
LDAP display name. You can remove more than one property by specifying a semicolon-separated list. The format
for this parameter is
-Remove @{Attribute1LDAPDisplayName=value[]; Attribute2LDAPDisplayName=value[]}
For example, if you want to add the values blue and green and remove the value pink from a property with a
LDAP display name of FavColors, set the Add and Remove parameters as follows.
-Add @{FavColors=Blue,Green} -Remove {FavColors=Pink}
When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the
following sequence:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Replace <Hashtable>
Specifies values for an object property that will replace 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 use the LDAP display name. You can modify more than one property by specifying a
comma-separated list. The format for this parameter is
-Replace @{Attribute1LDAPDisplayName=value[], Attribute2LDAPDisplayName=value[]}
For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for
Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows.
-Replace @{otherTelephone='555-222-2222', '555-222-1111'}
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ReversibleEncryptionEnabled <Boolean>
Specifies whether the directory must store passwords using reversible encryption. This parameter sets the
ReversibleEncryption property for a password policy. Possible values for this parameter include the following:
$false or 0
$true or 1
The following example shows how to set this parameter to true.
-ReversibleEncryptionEnabled $true
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Server <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 Powershell.
The following example shows how to specify a full qualified domain name as the parameter value.
-Server "corp.contoso.com"
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? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None or Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy
A fine grained password policy object is received by the Identity parameter.
A fine grained password policy object that was retrieved by using the Get-ADFineGrainedPasswordPolicy cmdlet
and then modified is received by the Instance parameter.
OUTPUTS
None or Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy
Returns the modified fine grained password policy object when the PassThru parameter is specified. By default,
this cmdlet does not generate any output.
NOTES
This cmdlet does not work with AD LDS.
This cmdlet does not work with an Active Directory Snapshot.
This cmdlet does not work with a read-only domain controller.
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>Set-ADFineGrainedPasswordPolicy MyPolicy -Precedence 100 -LockoutDuration 00:40:00 -LockoutObservationWindow
00:20:00 -ComplexityEnabled $true -ReversibleEncryptionEnabled $false -MinPasswordLength 12
Description
-----------
Update the Precedence, LockoutDuration, LockoutObservationWindow, ComplexityEnabled, ReversibleEncryptionEnabled,
and MinPasswordLength properties on the FineGrainedPasswordPolicy object with name MyPolicy.
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>Set-ADFineGrainedPasswordPolicy 'CN=MyPolicy,CN=Password Settings Container,CN=System,DC=FABRIKAM,DC=COM'
-MinPasswordLength 12
Description
-----------
Set the MinPasswordLength property on the FineGrainedPasswordPolicy object with DistinguishedName
CN=MyPolicy,CN=Password Settings Container,CN=System,DC=FABRIKAM,DC=COM.
-------------------------- EXAMPLE 3 --------------------------
C:\\PS>$fgpp = Get-ADFineGrainedPasswordPolicy MyPolicy
$fgpp.LockoutObservationWindow = [TimeSpan]::Parse("0.00:15:00")
$fgpp.LockoutThreshold = 10
$fgpp.MinPasswordLength = 8
$fgpp.PasswordHistoryCount = 24
Set-ADFineGrainedPasswordPolicy -Instance $fgpp
Description
-----------
Get the FineGrainedPasswordPolicy object with name MyPolicy, Update a set of properties on the object and then
write the modifications back to the directory using the instance parameter.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291118
Get-ADFineGrainedPasswordPolicy
New-ADFineGrainedPasswordPolicy
Remove-ADFineGrainedPasswordPolicy