Adds a new domain to the list of domains blocked for federation. By definition, your users are not allowed to use Microsoft Communications Server 2010 applications to communicate with people from the blocked domain; for example, users cannot employ Microsoft Communicator "14" to exchange instant messages with anyone with a SIP account in a domain that appears on the blocked list.
Syntax
New-CsBlockedDomain -Identity <XdsGlobalRelativeIdentity> [-Comment <String>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
New-CsBlockedDomain -Domain <String> [-Comment <String>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
String |
Fully qualified domain name (e.g., fabrikam.com) of the domain to be added to the blocked list. You can use either the -Identity or the -Domain parameter (but not both) in order to specify the domain name. If you use -Identity, the Domain property will be set to the same value assigned to -Identity. If you use -Domain, the Identity property will be set to the same value assigned to -Domain. Note that Identities must be unique: if the specified domain already exists on either the blocked or the allowed list your command will fail. |
|
Domain |
Optional |
String |
Fully qualified domain name (e.g., fabrikam.com) of the domain to be added to the blocked list. You can use either the -Identity or the -Domain parameter (but not both) in order to specify the domain name. If you use -Identity, the Domain property will be set to the same value assigned to -Identity. If you use -Domain, the Identity property will be set to the same value assigned to -Domain. Note that Domains must be unique: if the specified domain already exists on either the blocked or the allowed list your command will fail. |
|
Comment |
Optional |
String |
Optional string value that provides additional information about the blocked domain. For example, you might add a Comment that explains why the domain has been blocked. |
|
InMemory |
Optional |
Switch Parameter |
Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet. |
|
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 Communicator "14". 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.
The New-CsBlockedDomain cmdlet enables you to add a domain the list of blocked domains.
Return Types
Creates instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.Edge.BlockedDomain object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
New-CsBlockedDomain -Identity "fabrikam.com" -Comment "Blocked per Ken Myer." |
|
In the preceding example, the domain fabrikam.com is added to the list of blocked domains. To do this, New-CsBlockedDomain is called, along with the -Identity parameter; -Identity is assigned the name of the domain to be blocked. In addition, the -Comment parameter is included in order to add a comment to the blocked domain. Note that this command will fail if fabrikam.com is already on the blocked list, or if the domain is on the allowed list.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
$x = New-CsBlockedDomain -Identity "fabrikam.com" -InMemory $x.Comment = "Blocked per Ken Myer." Set-CsBlockedDomain -Instance $x |
|
Example 2 demonstrates how you can use the -InMemory parameter to create a new blocked domain that initially exists only in memory; after you modify the property values of this in-memory-only domain you can then call Set-CsBlockedDomain to add the domain to the blocked list.
To perform this task, the first line in the command uses New-CsBlockedDomain, and the -InMemory parameter, to create a blocked domain with the Identity fabrikam.com. Upon creation, this virtual domain is stored in the variable $x.
In the second line, the Comment property of the virtual domain is modified. After that’s done, line 3 uses the Set-CsBlockedDomain cmdlet to add the virtual domain to the blocked list. Without line 3, the virtual domain would exist only in memory and would never be added to the blocked list. Instead, the virtual domain will disappear as soon as you terminate your Windows PowerShell session or delete the variable $x.