Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-ADCentralAccessPolicy

Remove-ADCentralAccessPolicy

microsoft.activedirectory.management.dll

Synopsis

Removes a central access policy from Active Directory.

Syntax

Remove-ADCentralAccessPolicy [-Identity] [-AuthType] [-Credential] [-Server] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Remove-ADCentralAccessPolicy cmdlet can be used to remove a central access policy from Active Directory.

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.

Aliases

None

Required?

false

Position

named

Default value

Microsoft.ActiveDirectory.Management.AuthType.Negotiate

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.

If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Identity <ADCentralAccessPolicy>

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)

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByValue)

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.

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

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.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None or Microsoft.ActiveDirectory.Management.ADCentralAccessPolicy

Return Type

None

Notes

This cmdlet does not work with an Active Directory Snapshot.

This cmdlet does not work with a read-only domain controller.

By default, this cmdlet has the Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. To bypass prompting for confirmation before removal, you can specify -Confirm:$False when using this cmdlet.

Examples

-------------------------- EXAMPLE 1 --------------------------

This command removes the central access policy named Finance Policy.

PS C:\>Remove-ADCentralAccessPolicy -Identity "Finance Policy"

-------------------------- EXAMPLE 2 --------------------------

This command gets all resource property lists whose name starts with Finance and then remove them.

PS C:\>Get-ADCentralAccessPolicy -Filter 'Name -Like "Finance*"' | Remove-ADCentralAccessPolicy

Online Version
Get-ADCentralAccessPolicy
New-ADCentralAccessPolicy
Set-ADCentralAccessPolicy