Modifier

Get-ADCentralAccessPolicy

  • Reference
Module:
ActiveDirectory

Retrieves central access policies from Active Directory.

Syntax

Get-ADCentralAccessPolicy
   [-AuthType <ADAuthType>]
   [-Credential <PSCredential>]
   -Filter <String>
   [-Properties <String[]>]
   [-ResultPageSize <Int32>]
   [-ResultSetSize <Int32>]
   [-Server <String>]
   [<CommonParameters>]
Get-ADCentralAccessPolicy
   [-AuthType <ADAuthType>]
   [-Credential <PSCredential>]
   [-Identity] <ADCentralAccessPolicy>
   [-Properties <String[]>]
   [-Server <String>]
   [<CommonParameters>]
Get-ADCentralAccessPolicy
   [-AuthType <ADAuthType>]
   [-Credential <PSCredential>]
   -LDAPFilter <String>
   [-Properties <String[]>]
   [-ResultPageSize <Int32>]
   [-ResultSetSize <Int32>]
   [-Server <String>]
   [<CommonParameters>]

Description

The Get-ADCentralAccessPolicy cmdlet retrieves central access policies from Active Directory.

Examples

Example 1: Get a list off all central access policies

Get-ADCentralAccessPolicy -Filter *

This command retrieves a list of all central access policies.

Example 2: Get a list of specific central access policies using a filter

Get-ADCentralAccessPolicy -Filter "Members -eq 'Finance Documents Rule'"

This command gets the central access policies that have the central access rule Finance Documents Rule as its members.

Example 3: Get information for a central access policy for a specific Active Directory object

Get-ADCentralAccessPolicy -Identity "Finance Policy"

This command gets information for a central access policy named Finance Policy.

Parameters

-AuthType

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.

Type:ADAuthType
Accepted values:Negotiate, Basic
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

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

-Filter

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

-Identity

Specifies an Active Directory object by providing one of the following property values. The identifier in parentheses is the LDAP display name for the attribute.The acceptable values for this parameter are:

  • A distinguished name
  • A GUID (objectGUID)
  • A Security Identifier (objectSid)
  • A SAM account name (sAMAccountName)
Type:ADCentralAccessPolicy
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LDAPFilter

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

-Properties

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. To display all of the properties that are set on the object, specify an asterisk (*) wildcard.

To specify an individual extended property, use the name of the property. For properties that are not default or extended properties, you must specify the LDAP display name of the attribute.

Type:String[]
Aliases:Property
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResultPageSize

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

-ResultSetSize

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

-Server

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

Inputs

None or Microsoft.ActiveDirectory.Management.ADCentralAccessPolicy

An ADCentralAccessPolicy object is received by the Identity parameter.

Outputs

ADCentralAccessPolicy

This cmdlet returns one or more ADCentralAccessPolicy objects.

The cmdlet returns a default set of ADCentralAccessPolicy property values. To retrieve additional ADCentralAccessPolicy properties, use the Properties parameter of the cmdlet.