< Back
Get-ADAuthenticationPolicy
Post
NAME Get-ADAuthenticationPolicy
SYNOPSIS
Gets one or more Active Directory Domain Services authentication policies.
SYNTAX
Get-ADAuthenticationPolicy [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>] [-Properties <String[]>]
[-ResultPageSize <Int32>] [-ResultSetSize <Int32>] [-Server <String>] -Filter <String> [<CommonParameters>]
Get-ADAuthenticationPolicy [-Identity] <ADAuthenticationPolicy> [-AuthType {Negotiate | Basic}] [-Credential
<PSCredential>] [-Properties <String[]>] [-Server <String>] [<CommonParameters>]
Get-ADAuthenticationPolicy [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>] [-Properties <String[]>]
[-ResultPageSize <Int32>] [-ResultSetSize <Int32>] [-Server <String>] -LDAPFilter <String> [<CommonParameters>]
DESCRIPTION
The Get-ADAuthenticationPolicy cmdlet gets an authentication policy or performs a search to get authentication
policies.
The Identity parameter specifies the Active Directory Domain Services authentication policy to get. You can
identify an authentication policy by its distinguished name (DN), GUID or 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.
You can search for and use multiple authentication policies by specifying the Filter parameter or the LDAPFilter
parameter. The Filter parameter uses the Windows PowerShell???? expression language to write query strings for Active
Directory Domain Services. Windows PowerShell expression language syntax provides rich type conversion support for
value types received by the Filter parameter. For more information about the Filter parameter syntax, see
about_ActiveDirectory_Filter. If you have existing LDAP query strings, you can use the LDAPFilter parameter.
PARAMETERS
-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.
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 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 ServicesWindows 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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Filter <String>
Specifies a query string that retrieves Active Directory Domain Services objects. This string uses the Windows
PowerShell expression language syntax. The Windows PowerShell expression language syntax provides rich
type-conversion support for value types received by the Filter parameter.
Specify the Filter parameter in one of the following formats:
--To match a single filter element: {Attributeoperator "value"}
--To match multiple filter elements: {(Attribute1operator1 "value1") joinOperator (Attribute2operator2
"value2")}
Windows PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax.
Valid filter operators are:
-eq, -le, -ge, -ne, -lt, -gt, -approx, -bor, -band, -recursivematch, -like, -notlike
Valid join operators are:
-and, -or
The not operator is -not
For a list of supported types for values, see about_ActiveDirectory_ObjectModel. For more information about
the Filter parameter, see about_ActiveDirectory_Filter.
Required? true
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
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.
Required? true
Position? 0
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-LDAPFilter <String>
Specifies an LDAP query string used to filter Active Directory Domain Services objects. Use this parameter to
run your existing LDAP queries.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Properties <String[]>
Specifies the properties of the output object to get from the server. Use this parameter to get properties
that are not included in the default set.
Specify the properties to get as a comma separated list of names. For properties that are not default or
extended properties, you must specify the LDAP display name of the property. To display all of the properties
that are set on the object, specify an asterisk wildcard.
To get properties for an object and display them, you can use this cmdlet and pass the output to the
Get-Member cmdlet by using the pipeline operator.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ResultPageSize <Int32>
Specifies the number of objects to include in one page for an Active Directory Domain Services query. The
default value is 256 objects per page.
Required? false
Position? named
Default value 256
Accept pipeline input? false
Accept wildcard characters? false
-ResultSetSize <Int32>
Specifies the maximum number of objects to return for an Active Directory Domain Services query. If you want
to get all of the objects, set this parameter to $Null. You can use Ctrl+C to stop the query and the return of
objects.
The default value is $Null.
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.
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 ServicesWindows PowerShell
provider drive, when the cmdlet runs in that drive
--By using the domain of the computer running Windows PowerShell
Required? false
Position? named
Default value
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.ADAuthenticationPolicy
This cmdlet accepts an authentication policy object.
OUTPUTS
Microsoft.ActiveDirectory.Management.ADAuthenticationPolicy
Returns one or more authentication policy objects. This cmdlet returns a default set of ADAuthenticationPolicy
property values. To retrieve additional ADAuthenticationPolicy properties, use the Properties parameter.
Example 1: Get an authentication policy
PS C:\\> Get-ADAuthenticationPolicy -Identity AuthenticationPolicy01
This command gets an authentication policy object by specifying the object name.
Example 2: Get an authentication policy by using an LDAP filter
PS C:\\> Get-ADAuthenticationPolicy -LDAPFilter "(name=AuthenticationPolicy*)" -Server Server01.Contoso.com
This command gets all authentication policies that match the LDAP filter specified by the LDAPFilter parameter.
Example 3: Get an authentication policy by using a filter
PS C:\\> Get-ADAuthenticationPolicy -Filter "Name -like 'AuthenticationPolicy*'" -Server Server02.Contoso.com
This command gets all authentication policies that match the filter specified by the Filter parameter.
Example 4: Get all authentication policy objects that match a filter
PS C:\\> Get-ADAuthenticationPolicy -Filter * | Format-Table Name, Enforce -AutoSize
Name Enforce
---- -------
AuthenticationPolicy1 False
AuthenticationPolicy2 False
This command gets all the authentication policies available. The output is then passed to the Format-Table cmdlet
to display the name of the policy and the value for Enforce on each policy.
Example 5: Get all properties for an authentication policy
PS C:\\> Get-ADAuthenticationPolicy -Identity "AuthenticationPolicy01" -Properties "*"
This command gets all properties of the authentication policy specified by the Identity parameter.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=288129
New-ADAuthenticationPolicy
Remove-ADAuthenticationPolicy
Set-ADAuthenticationPolicy
SYNOPSIS
Gets one or more Active Directory Domain Services authentication policies.
SYNTAX
Get-ADAuthenticationPolicy [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>] [-Properties <String[]>]
[-ResultPageSize <Int32>] [-ResultSetSize <Int32>] [-Server <String>] -Filter <String> [<CommonParameters>]
Get-ADAuthenticationPolicy [-Identity] <ADAuthenticationPolicy> [-AuthType {Negotiate | Basic}] [-Credential
<PSCredential>] [-Properties <String[]>] [-Server <String>] [<CommonParameters>]
Get-ADAuthenticationPolicy [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>] [-Properties <String[]>]
[-ResultPageSize <Int32>] [-ResultSetSize <Int32>] [-Server <String>] -LDAPFilter <String> [<CommonParameters>]
DESCRIPTION
The Get-ADAuthenticationPolicy cmdlet gets an authentication policy or performs a search to get authentication
policies.
The Identity parameter specifies the Active Directory Domain Services authentication policy to get. You can
identify an authentication policy by its distinguished name (DN), GUID or 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.
You can search for and use multiple authentication policies by specifying the Filter parameter or the LDAPFilter
parameter. The Filter parameter uses the Windows PowerShell???? expression language to write query strings for Active
Directory Domain Services. Windows PowerShell expression language syntax provides rich type conversion support for
value types received by the Filter parameter. For more information about the Filter parameter syntax, see
about_ActiveDirectory_Filter. If you have existing LDAP query strings, you can use the LDAPFilter parameter.
PARAMETERS
-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.
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 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 ServicesWindows 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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Filter <String>
Specifies a query string that retrieves Active Directory Domain Services objects. This string uses the Windows
PowerShell expression language syntax. The Windows PowerShell expression language syntax provides rich
type-conversion support for value types received by the Filter parameter.
Specify the Filter parameter in one of the following formats:
--To match a single filter element: {Attributeoperator "value"}
--To match multiple filter elements: {(Attribute1operator1 "value1") joinOperator (Attribute2operator2
"value2")}
Windows PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax.
Valid filter operators are:
-eq, -le, -ge, -ne, -lt, -gt, -approx, -bor, -band, -recursivematch, -like, -notlike
Valid join operators are:
-and, -or
The not operator is -not
For a list of supported types for values, see about_ActiveDirectory_ObjectModel. For more information about
the Filter parameter, see about_ActiveDirectory_Filter.
Required? true
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
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.
Required? true
Position? 0
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-LDAPFilter <String>
Specifies an LDAP query string used to filter Active Directory Domain Services objects. Use this parameter to
run your existing LDAP queries.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Properties <String[]>
Specifies the properties of the output object to get from the server. Use this parameter to get properties
that are not included in the default set.
Specify the properties to get as a comma separated list of names. For properties that are not default or
extended properties, you must specify the LDAP display name of the property. To display all of the properties
that are set on the object, specify an asterisk wildcard.
To get properties for an object and display them, you can use this cmdlet and pass the output to the
Get-Member cmdlet by using the pipeline operator.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ResultPageSize <Int32>
Specifies the number of objects to include in one page for an Active Directory Domain Services query. The
default value is 256 objects per page.
Required? false
Position? named
Default value 256
Accept pipeline input? false
Accept wildcard characters? false
-ResultSetSize <Int32>
Specifies the maximum number of objects to return for an Active Directory Domain Services query. If you want
to get all of the objects, set this parameter to $Null. You can use Ctrl+C to stop the query and the return of
objects.
The default value is $Null.
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.
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 ServicesWindows PowerShell
provider drive, when the cmdlet runs in that drive
--By using the domain of the computer running Windows PowerShell
Required? false
Position? named
Default value
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.ADAuthenticationPolicy
This cmdlet accepts an authentication policy object.
OUTPUTS
Microsoft.ActiveDirectory.Management.ADAuthenticationPolicy
Returns one or more authentication policy objects. This cmdlet returns a default set of ADAuthenticationPolicy
property values. To retrieve additional ADAuthenticationPolicy properties, use the Properties parameter.
Example 1: Get an authentication policy
PS C:\\> Get-ADAuthenticationPolicy -Identity AuthenticationPolicy01
This command gets an authentication policy object by specifying the object name.
Example 2: Get an authentication policy by using an LDAP filter
PS C:\\> Get-ADAuthenticationPolicy -LDAPFilter "(name=AuthenticationPolicy*)" -Server Server01.Contoso.com
This command gets all authentication policies that match the LDAP filter specified by the LDAPFilter parameter.
Example 3: Get an authentication policy by using a filter
PS C:\\> Get-ADAuthenticationPolicy -Filter "Name -like 'AuthenticationPolicy*'" -Server Server02.Contoso.com
This command gets all authentication policies that match the filter specified by the Filter parameter.
Example 4: Get all authentication policy objects that match a filter
PS C:\\> Get-ADAuthenticationPolicy -Filter * | Format-Table Name, Enforce -AutoSize
Name Enforce
---- -------
AuthenticationPolicy1 False
AuthenticationPolicy2 False
This command gets all the authentication policies available. The output is then passed to the Format-Table cmdlet
to display the name of the policy and the value for Enforce on each policy.
Example 5: Get all properties for an authentication policy
PS C:\\> Get-ADAuthenticationPolicy -Identity "AuthenticationPolicy01" -Properties "*"
This command gets all properties of the authentication policy specified by the Identity parameter.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=288129
New-ADAuthenticationPolicy
Remove-ADAuthenticationPolicy
Set-ADAuthenticationPolicy