Remove-ExchangeAdministrator
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Remove-ExchangeAdministrator cmdlet to remove a user or group from a particular Microsoft Exchange Server 2007 role.
Syntax
Remove-ExchangeAdministrator -Identity <SecurityPrincipalIdParameter> -Role <OrgAdmin | RecipientAdmin | ServerAdmin | ViewOnlyAdmin | PublicFolderAdmin> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Scope <String>] [-WhatIf [<SwitchParameter>]]
Detailed Description
Only Exchange Organization administrators can successfully remove users or groups from the Exchange 2007 built-in roles.
To run the Remove-ExchangeAdministrator cmdlet, 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.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.SecurityPrincipalIdParameter |
The Identity parameter specifies the user to remove from the role. |
Role |
Required |
Microsoft.Exchange.Management.RecipientTasks.DelegateRoleType |
The Role parameter returns only the specified role type. |
Scope |
Optional |
System.String |
The Scope parameter specifies the name of the server for which the user will have administrative privileges. Scope is required when defining the ServerAdmin role. When the role is OrgAdmin or MailboxAdmin, the scope is the entire organization. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the domain controller to use to write this configuration change to Active Directory. Use the fully qualified domain name (FQDN) of the domain controller that you want to use. |
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 do not have to specify a value with the Confirm parameter. |
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. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
Exceptions
| Exceptions | Description |
|---|---|
Example
The following code is an example of the Remove-ExchangeAdministrator command. This command removes the user Ted Bremer from the OrgAdmin role.
Remove-ExchangeAdministrator -Role OrgAdmin -Identity TedBrem