Returns information about the domains included on 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 Session Initiation Protocol (SIP) account in a domain on the blocked list.
Syntax
Get-CsBlockedDomain [-Identity <XdsGlobalRelativeIdentity>] [-LocalStore <SwitchParameter>] |
Get-CsBlockedDomain [-Filter <String>] [-LocalStore <SwitchParameter>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
String |
Name of the domain to be returned. Domains are listed on the blocked list by their fully qualified domain name; thus the Identity for a given domain might be fabrikam.com or contoso.net. You cannot use wildcards when specifying a domain Identity. To use wildcards to return a given domain (or set of domains) use the -Filter parameter instead. If this parameter is not specified then all the domains on the blocked domain list will be returned. |
|
Filter |
Optional |
String |
Enables you to use wildcard characters in order to return one or more domains from the list of blocked domains. To return all the domains that have an Identity (the only property you can filter on) that begins with the letter "f" use this syntax: -Filter f*. To return all the domains that have an Identity that ends with ".uk" use this syntax: -Filter .uk*. To return all the domains that have an Identity that begins with the letter "f" or with the letter "g" use this syntax: -Filter [fg]*. |
|
LocalStore |
Optional |
Switch Parameter |
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 2010.
The Get-CsBlockedDomain cmdlet enables you to return information about the domains that appear on the blocked domain list.
Return Types
Returns instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.Edge.BlockedDomain object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Get-CsBlockedDomain |
|
The command shown in Example 1 returns a collection of all the domains included on the blocked domain list; this is done by calling Get-CsBlockedDomain without any additional parameters.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsBlockedDomain -Identity fabrikam.com |
|
In Example 2, the only blocked domain returned is the one with the Identity "fabrikam.com". Because domains on the blocked list must have unique identities, this command will always return, at most, a single item.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsBlockedDomain -Filter *.net |
|
Example 3 uses the -Filter parameter to return a collection of all the blocked domains that have an identity that ends in the string value ".net". This sample command returns such domains as northwindtraders.net, contoso.net, and fabrikam.net.
-------------------------- Example 4 ------------------------
| Copy Code |
|
|---|---|
Get-CsBlockedDomain | Where-Object {$_.Comment -eq $Null}
|
|
The preceding command returns a collection of all the domains where the Comment property has no value. To do this, the command first uses Get-CsBlockedDomain to return a collection of all the domains on the blocked list. This collection is then piped to the Where-Object cmdlet, which selects only those domains where the Comment property is equal to (-eq) a null value ($Null).
-------------------------- Example 5 ------------------------
| Copy Code |
|
|---|---|
Get-CsBlockedDomain | Where-Object {$_.Comment -match "Ken Myer"}
|
|
In Example 5, all the blocked domains that include the string value "Ken Myer" somewhere in the Comment property are returned. To carry out this task, get-CsBlockedDomain is first called in order to return a collection of all the domains on the blocked domains list. This collection is then piped to Where-Object, which picks out those domains where the Comment property contains (-match) the string value "Ken Myer".