Applies to: Exchange Server 2007 SP3, Exchange Server
2007 SP2, Exchange Server 2007 SP1
Topic Last Modified: 2009-05-12
Use the Remove-AddressList cmdlet to remove an existing address list.
Syntax
Remove-AddressList -Identity
<AddressListIdParameter> [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-Recursive
<SwitchParameter>] [-UseRusServer <String>] [-WhatIf
[<SwitchParameter>]]
|
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.AddressListIdParameter |
Use the Identity parameter to specify the GUID, distinguished name or address list name that represents a specific address list. You can also include the path by using the format Path\AddressListName. You can omit the parameter label Identity so that only the address list name or GUID is supplied. |
||
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm parameter causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm parameter. |
||
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
This parameter specifies the domain controller to use to remove the address list from the Active Directory directory service. |
||
|
Recursive |
Optional |
System.Management.Automation.SwitchParameter |
This parameter specifies whether the command will remove all child address lists of the address list specified by the Identity parameter. If you do not specify this parameter and the address list to remove has child address lists, the command will fail. |
||
|
UseRusServer |
Optional |
System.String |
The UseRusServer parameter instructs the command to use the specified Mailbox server on which the Address List service is running to obtain and then set mailbox and Active Directory user attributes. The Address List service is a component in the Exchange System Attendant service. The Address List service creates and maintains Exchange-specific attribute values in Active Directory. You can use the Address List service to update recipient objects in a domain by using specific information, such as address list membership and e-mail addresses. |
||
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf parameter. |
Note:Detailed Description
To run the Remove-AddressList cmdlet, To perform this procedure, the account you use must be delegated the following:
- Exchange Organization Administrator role
For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
|
Example
The following example shows how to remove an address list with the Name "Address_List_1", and all of its child address lists.
 Copy Code |
|
|---|---|
Remove-AddressList -Identity "Address_List_1" -Recursive |
|
Use the Get-AddressList cmdlet, piped to format-list, to get the GUID, distinguished name, or path and name of an existing address list. Or use Get-AddressList to get a specific existing address list, and then pipe the output directly to Remove-AddressList.