Share via

  • Article

Get-CsAllowedDomain

 

Topic Last Modified: 2012-03-23

Returns information about the domains included on the list of domains approved for federation. After a domain has been approved for federation (by being added to the allowed list), your users can exchange instant messages and presence information with people who have accounts in that domain.

Syntax

Get-CsAllowedDomain [-Identity <XdsGlobalRelativeIdentity>] [-LocalStore <SwitchParameter>]

Get-CsAllowedDomain [-Filter <String>] [-LocalStore <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 Microsoft Lync 2010. Microsoft 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 (required if EnablePartnerDiscovery has been disabled) 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 Get-CsAllowedDomain cmdlet provides a way for you to return information about all the domains on the allowed domains list.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsAllowedDomain cmdlet locally: RTCUniversalUserAdmins, 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 "Get-CsAllowedDomain"}

Parameters

Parameter Required Type Description

Identity

Optional

String

Name of the domain to be returned. Domains are listed on the allowed list by their fully qualified domain name (FQDN); that means that the Identity for a given domain will be similar to fabrikam.com or contoso.net. Note that 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 of the domains on the allowed 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 allowed domains. To return all of the domains that have an Identity that begins with the letter "r", use this syntax: -Filter r*. To return all of the domains that have an Identity that ends with ".net", use this syntax: -Filter "*.net". To return all of the domains that have an Identity that begins with the letter "r" or with the letter "g", use this syntax: -Filter [rg]*.

LocalStore

Optional

Switch Parameter

Retrieves the allowed domains from the local replica of the Central Management store rather than from the Central Management store itself.

Input Types

None. Get-CsAllowedDomain does not accept pipelined input.

Return Types

Returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain object.

Example

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

Get-CsAllowedDomain

The preceding command returns a collection of all the domains included in the list of domains approved for federation. Calling Get-CsAllowedDomain without any additional parameters always returns the complete collection of approved domains.

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

Get-CsAllowedDomain -Identity fabrikam.com

Example 2 returns information about the allowed domain with the Identity "fabrikam.com". Because identities must be unique, this command will never return more than one item.

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

Get-CsAllowedDomain -Filter *fabrikam*

The command shown in Example 3 returns a collection of all the allowed domains that have the string value "fabrikam" anywhere in their Identity. To do this, the command uses the Filter parameter and the filter value "*fabrikam*". This filter value tells Get-CsAllowedDomain to return only those domains where the Identity (the only property you can filter on) includes the string value "fabrikam". Domains such as fabrikam.com, fabrikam.net, and africa.fabrikam.org will all be returned by this command.

-------------------------- Example 4 ------------------------

Get-CsAllowedDomain | Where-Object {$_.ProxyFqdn -eq $Null}

In Example 4, the Get-CsAllowedDomain and the Where-Object cmdlets are used to return a collection of all the domains where no value has been entered for the ProxyFqdn property. To carry out this task, Get-CsAllowedDomain is first called without any additional parameters in order to return a collection of all the allowed domains. This collection is then piped to Where-Object, which selects only those allowed domains where the ProxyFqdn property is equal to a null value; a null value means that no value has been entered for ProxyFqdn. To find all the domains that have a value of some kind configured for the ProxyFqdn property, use this syntax instead:

Where-Object {$_.ProxyFqdn -ne $Null}

-------------------------- Example 5 ------------------------

Get-CsAllowedDomain | Where-Object {$_.MarkForMonitoring -eq $True}

The preceding command returns all the allowed domains that have their health status checked by the Monitoring Server. To do this, Get-CsAllowedDomain is first used to return a collection of all the domains on the allowed domains list. That collection is then piped to the Where-Object cmdlet, which picks out only those domains where the MarkForMonitoring property is equal to True.