Article
07/23/2014

Set-CsBlockedDomain

Topic Last Modified: 2012-03-26

Modifies the Comment property for one or more of the domains included on the list of domains that are blocked for federation. By definition, your users are not allowed to use Microsoft Lync Server 2010 applications to communicate with people from the blocked domain; for example, users cannot employ Microsoft Lync 2010 to exchange instant messages with anyone with a SIP account in a domain that appears on the blocked list.

Syntax

Set-CsBlockedDomain [-Identity <XdsGlobalRelativeIdentity>] [-Comment <String>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Set-CsBlockedDomain [-Comment <String>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-WhatIf [<SwitchParameter>]]

Detailed Description

Federation is a means by which two organizations can set up a trust relationship that facilitates communication between the two groups. When 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 by using SIP applications such as Lync 2010. Lync 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. In addition, the other organization must enable federation with you; federation cannot be established unless both parties agree to the relationship.

To set up a federated relationship you might also need to 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 users are expressly forbidden from federating with; for example, messages sent from a blocked domain will automatically be rejected by Lync Server 2010.

The Comment property, the only property of a blocked domain that can be modified, is used to store additional information about a domain on the blocked list (for example, why the domain is being blocked; when the domain can be removed from the blocked list; or who to contact if you would like to have the domain removed from the blocked list). If you need to change the Comment property for any domain on the list of blocked domains, use the Set-CsBlockedDomain cmdlet.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsBlockedDomain cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsBlockedDomain"}

Parameters

Parameter	Required	Type	Description
Identity	Required	String	Fully qualified domain name (FQDN) of the blocked domain for which the Comment property is being modified. For example: fabrikam.com
Instance	Optional	BlockedDomain object	Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.
Comment	Optional	String	Enables you to provide additional information about the domain being modified. For example, you might add a Comment that indicates why the domain has been placed on the blocked list.
Force	Optional	Switch Parameter	Suppresses the display of any non-fatal error message that might occur 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.

Input Types

Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain object. Set-CsBlockedDomain accepts pipelined instances of the blocked domain object.

Return Types

Set-CsBlockedDomain does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain object.

Example

-------------------------- Example 1 ------------------------

Set-CsBlockedDomain -Identity fabrikam.com -Comment "Block this domain pending legal review."

The command shown in Example 1 modifies the Comment for the blocked domain with the Identity "fabrikam.com". In this example, the Comment parameter is included along with the parameter value, "Block this domain pending legal review."

-------------------------- Example 2 ------------------------

Get-CsBlockedDomain | Set-CsBlockedDomain -Comment "Block this domain pending legal review."

In the preceding example, the Comment property is updated for all the domains included on the blocked domains list. To do this, the command first calls Get-CsBlockedDomain, which returns a collection of all the domains currently on the blocked domain list. That collection is then piped to Set-CsBlockedDomain, which proceeds to modify the Comment property for each domain in the collection.

-------------------------- Example 3 ------------------------

Get-CsBlockedDomain | Where-Object {$_.Comment -eq $Null} | Set-CsBlockedDomain -Comment "Block this domain pending legal review."

In Example 3, a new comment ("Block this domain pending legal review.") is added to each domain on the blocked list that doesn’t already have a value configured for the Comment property. To carry out this task, the command first uses Get-CsBlockedDomain to return a collection of all the domains currently on the blocked list. This collection is then piped to the Where-Object cmdlet, which picks out only those domains where the Comment property is equal to a null value. The filtered collection is then piped to Set-CsBlockedDomain, which assigns the same comment to the Comment property of each domain in the filtered collection.

Share via