[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Returns information about the domains included on 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


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


Get-CsAllowedDomain [-Filter <String>] [-LocalStore <SwitchParameter>]

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; 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 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 the domains who 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

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; 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 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 the domains who 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 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.

The Get-CsAllowedDomain cmdlet provides a way for you to return information about all the domains on the allowed domains list.

Return Types

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

Examples

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

	Copy Code
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 will always return the complete collection of approved domains.

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

	Copy Code
Get-CsAllowedDomain -Identity fabrikam.com

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

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

	Copy Code
Get-CsAllowedDomain -Filter fabrikam

The command shown in Example 3 returns a collection of all the approved 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 customers.fabrikam.org will all be returned by this command.

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

	Copy Code
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 approved domains. This collection is then piped to Where-Object, which selects only those allowed domains where the ProxyFqdn property is equal to (-eq) a null value ($Null). A null value means that no value has been entered for ProxyFqdn. To find all the domains that have a value entered for ProxyFqdn, use this Where clause instead:

{$_.ProxyFqdn -ne $Null}

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

	Copy Code
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 approved 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 ($True).