Get-ADAuthenticationPolicy
Gets one or more Active Directory Domain Services authentication policies.
Get-ADAuthenticationPolicy
[-AuthType <ADAuthType>]
[-Credential <PSCredential>]
-Filter <String>
[-Properties <String[]>]
[-ResultPageSize <Int32>]
[-ResultSetSize <Int32>]
[-Server <String>]
[<CommonParameters>]
Get-ADAuthenticationPolicy
[-AuthType <ADAuthType>]
[-Credential <PSCredential>]
[-Identity] <ADAuthenticationPolicy>
[-Properties <String[]>]
[-Server <String>]
[<CommonParameters>]
Get-ADAuthenticationPolicy
[-AuthType <ADAuthType>]
[-Credential <PSCredential>]
-LDAPFilter <String>
[-Properties <String[]>]
[-ResultPageSize <Int32>]
[-ResultSetSize <Int32>]
[-Server <String>]
[<CommonParameters>]
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, 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, type
Get-Help about_ActiveDirectory_Filter
. If you have existing Lightweight Directory Access Protocol
(LDAP) query strings, you can use the LDAPFilter parameter.
Get-ADAuthenticationPolicy -Identity AuthenticationPolicy01
This command gets an authentication policy object by specifying the object name.
Get-ADAuthenticationPolicy -LDAPFilter "(name=AuthenticationPolicy*)" -Server Server01
This command gets all authentication policies that match the LDAP filter specified by the LDAPFilter parameter.
Get-ADAuthenticationPolicy -Filter "Name -like 'AuthenticationPolicy*'" -Server Server02
This command gets all authentication policies that match the filter specified by the Filter parameter.
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.
Get-ADAuthenticationPolicy -Identity "AuthenticationPolicy01" -Properties "*"
This command gets all properties of the authentication policy specified by the Identity parameter.
Specifies the authentication method to use. The acceptable values for this parameter are:
Negotiate
or0
Basic
or1
The default authentication method is Negotiate
.
A Secure Sockets Layer (SSL) connection is required for the Basic
authentication method.
Type: | ADAuthType |
Accepted values: | Negotiate, Basic |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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 module for Windows 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.
If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error.
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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:
{Attribute operator "value"}
- To match multiple filter elements:
{(Attribute1 operator1 "value1") joinOperator (Attribute2 operator2 "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
.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies an Active Directory Domain Services authentication policy object. Specify the authentication policy object in one of the following formats:
- A 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.
Type: | ADAuthenticationPolicy |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Specifies a filter using the LDAP search filter syntax defined in RFC2254 to filter Active Directory Domain Services objects.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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.
Type: | String[] |
Aliases: | Property |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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
.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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.
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
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
None or Microsoft.ActiveDirectory.Management.ADAuthenticationPolicy
This cmdlet accepts an authentication policy object.
This cmdlet 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.