Removes a domain from the list of domains approved for federation. When a domain has been approved for federation (by being added to the allowed list) that means your users can exchange instant messages and presence information with people who have accounts in the federated domain.
Syntax
Remove-CsAllowedDomain -Identity <XdsGlobalRelativeIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
String |
Fully qualified domain name (e.g., fabrikam.com) of the domain to be removed from the allowed list. Note that you cannot use wildcards when specifying a domain Identity. |
|
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
|
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
|
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Detailed Description
Federation is a means by which two organizations can set up a trust relationship that facilitates communication between the two groups. When a federation has been established, users in the two organizations can send each other instant messages, subscribe for presence notifications, and otherwise communicate with one another using SIP applications such as Microsoft Communicator "14". Microsoft Communications Server 2010 allows for three types of federation: 1) direct federation between your organization and another; 2) federation between your organization and a public provider; and, 3) federation between your organization and a third-party hosting provider.
Setting up direct federation with another organization involves several tasks. To begin with, you must enable your Access Edge servers to allow federation; for more information, type "Get-Help Set-CsAccessEdgeConfiguration" (without the quote marks) at the windows PowerShell prompt. In addition, the other organization must enable federation with you; federation cannot be established unless both parties agree to the relationship.
Equally important, you must manage two federation-related lists: the allowed list and the blocked list. The allowed list represents the organizations you have chosen to federate with; if a domain appears on the allowed list then (depending on your configuration settings) your users will be able to exchange instant messages and presence information with users who have accounts in that federated domain. Conversely, the blocked list represents domains that you are expressly forbidden from federating with: messages sent from a blocked domain will automatically be rejected by Communications Server 2010.
If you wish to discontinue a federation relationship, use the Remove-CsAllowedDomain cmdlet to remove the appropriate domain from the list of allowed domains.
Return Types
Deletes instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.Edge.AllowedDomain object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Remove-CsAllowedDomain -Identity fabrikam.com |
|
The command shown in Example 1 removes the domain fabrikam.com from the list of allowed domains.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsAllowedDomain -Filter *fabrikam* | Remove-CsAllowedDomain |
|
In Example 2, all the domains that have the string value "fabrikam" somewhere in their Identity are removed from the list of allowed domains. To do this, the command first uses Get-CsAllowedDomain and the -Filter parameter to return a collection of domains that have the string value "fabrikam" somewhere in their Identity (the only property you can filter on). That filtered collection is then piped to Remove-CsAllowedDomain, which, in turn, removes all the items (domains) in the filtered collection from the list of allowed domains.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsAllowedDomain | Where-Object {$_.ProxyFqdn -eq $Null} | Remove-CsAllowedDomain
|
|
Example 3 removes all the domains without an identified proxy server from the list of allowed domains. To carry out this task, Get-CsAllowedDomain is called to return a collection of all the domains currently on the allowed list. That collection is piped to the Where-Object cmdlet, which picks out only those domains where the ProxyFqdn property is equal to (-eq) a null value ($Null). That filtered collection is then piped to Remove-CsAllowedDomain, which removes each domain in the collection from the allowed list.
-------------------------- Example 4 ------------------------
| Copy Code |
|
|---|---|
Get-CsAllowedDomain | Where-Object {$_.Comment -match "Ken Myer"} | Remove-CsAllowedDomain
|
|
In the preceding example, all the domains where the Comment field contains the string value "Ken Myer" are removed from the list of allowed domains. To do this, the command first uses Get-CsAllowedDomain to retrieve a collection of all the domains currently on the allowed domains list. This collection is then piped to the Where-Object cmdlet, which selects only those domains where the Comment property contains (-match) the string value "Ken Myer". This filtered collection is then piped to Remove-CsAllowedDomain, which removes each item in the collection from the list of allowed domains.