Site icon TOSS

Remove-ADObject

Karthik S
powershell

Remove-ADObject is accessible with the help of addsadministration module. To install addsadministration on your system please refer to this link.

Synopsis

Removes an Active Directory object.

Description

The Remove-ADObject cmdlet removes an Active Directory object. You can use this cmdlet to remove any type of Active Directory object.

The Identity parameter specifies the Active Directory object to remove. You can identify an object by its distinguished name (DN) or GUID. You can also set the Identity parameter to an Active Directory object variable, such as $, or pass an object through the pipeline to the Identity parameter. For example, you can use the Get-ADObject cmdlet to retrieve an object and then pass the object through the pipeline to the Remove-ADObject cmdlet.

If the object you specify to remove has child objects, you must specify the Recursive parameter.

For AD LDS environments, the Partition parameter must be specified except when: – Using a DN to identify objects: the partition will be auto-generated from the DN. – Running cmdlets from an Active Directory provider drive: the current path will be used to set the partition. – A default naming context or partition is specified.

To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance.

Parameters 

-AuthType 
         Specifies the authentication method to use. Possible values for this parameter include:

    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.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Identity <ADObject>
    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.

    Required?                    true
    Position?                    1
    Default value                
    Accept pipeline input?       True (ByValue)
    Accept wildcard characters?  false

-IncludeDeletedObjects <SwitchParameter>
    Specifies to retrieve deleted objects and the deactivated forward and backward links. When this parameter is specified, the cmdlet uses the following LDAP controls:

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Partition <String>
    Specifies the distinguished name of an Active Directory partition. The distinguished name must be one of the naming contexts on the current directory server. The cmdlet searches this partition to find the object defined by the Identity parameter.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Recursive <SwitchParameter>
    Specifies that the cmdlet should remove the object and any children it contains.

    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.

    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

Syntax

Remove-ADObject [-WhatIf] [-Confirm] [-AuthType <ADAuthType>] [-Credential <PSCredential>] [-Identity] <ADObject> [-IncludeDeletedObjects] [-Partition <String>] [-Recursive] [-Server <String>] [<CommonParameters>]

Notes
This cmdlet does not work with an Active Directory Snapshot.

————————– EXAMPLE 1 ————————–
C:\PS>Remove-ADObject ‘CN=Kamal-lap,CN=Computers,DC=TOSSolution,DC=COM’

Confirm
Are you sure you want to perform this action?
Performing operation "Remove" on Target "CN=Kamal-lap,CN=Computers,DC=TOSSolution,DC=COM".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): y

Remove the object identified by the DistinguishedName ‘CN=Kamal-lap,CN=Computers,DC=TOSSolution,DC=COM’.

————————– EXAMPLE 2 ————————–
C:\PS>Remove-ADObject “OU=Finance,OU=UserAccounts,DC= TOSSolution ,DC=COM” -Recursive

Confirm
Are you sure you want to perform this action?
Performing operation "Remove" on Target "OU=Finance,OU=UserAccounts,DC=TOSSolution,DC=COM".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): y

Deletes the container with DistinguishedName ‘OU=Finance,OU=UserAccounts,DC=TOSSolution,DC=COM’ including the child objects. Note: All the children of the container including the ones which are protected from accidental deletion are also deleted.

————————– EXAMPLE 3 ————————–
C:\PS>Remove-ADObject “823923g7-ea80-45e1-bc93-08a78d8c4853” -Confirm:$false

Removes the object with objectGUID ‘823923g7-ea80-45e1-bc93-08a78d8c4853’ without giving the confirmation prompt.

————————– EXAMPLE 4 ————————–
C:\PS>Remove-ADObject -Identity “CN=InternalApps,DC=AppNC” -server “TOSSolution-SRV1:60000”

Confirm
Are you sure you want to perform this action?
Performing operation "Remove" on Target "CN=InternalApps,DC=AppNC".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): y

removes the object with DistinguishedName ‘CN=InternalApps,DC=AppNC’ from an LDS instance.

————————– EXAMPLE 5 ————————–
C:\PS>Get-ADObject -Filter ‘isDeleted -eq $true -and -not (isRecycled -eq $true) -and name -ne “Deleted Objects” -and lastKnownParent -eq “OU=Accounting,DC=TOSSolution,DC=com”‘ -IncludeDeletedObjects | Remove-ADObject
Recycles all the objects in the recycle bin which used to be in the container ‘OU=Accounting,DC=TOSSolution,DC=com’.

You can check the Version, CommandType and Source of this cmdlet by giving below command.

Get-Command Remove-ADObject

You can also read about
. Get-ADObject
. New-ADObject
. Set-ADObject

To know more PowerShell cmdlets(Commands) on addsadministration (Active Directory) click here

Click on this Link for an Single place where you get all the PowerShell cmdlet sorted based on the modules.

You can also refer other blogs on PowerShell at link

You can also refer other blogs on Microsoft at link

And also if you required any technology you want to learn, let us know below we will publish them in our site http://tossolution.com/

Like our page in Facebook and follow us for New technical information.

References are taken from Microsoft

Exit mobile version