Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2012-06-29
Use the Get-FederationInformation cmdlet to get federation information, including federated domain names and target URLs, from an external Exchange organization.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Get-FederationInformation -DomainName <SmtpDomain>
[-BypassAdditionalDomainValidation <SwitchParameter>] [-Force
<SwitchParameter>] [-TrustedHostnames
<MultiValuedProperty>]
|
Examples
EXAMPLE 1
This example gets federation information from the domain contoso.com.
 Copy Code |
|
|---|---|
Get-FederationInformation -DomainName contoso.com |
|
Detailed Description
The Get-FederationInformation cmdlet retrieves federation information from the domain specified. Results from the cmdlet can be piped to the New-OrganizationRelationship cmdlet to establish an organization relationship with the Exchange organization being queried.
The domain specified should have federation enabled.
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Federation trusts" entry in the Exchange and Shell Infrastructure Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
DomainName |
Required |
Microsoft.Exchange.Data.SmtpDomain |
The DomainName parameter specifies the domain name for which federation information is to be retrieved. |
|
BypassAdditionalDomainValidation |
Optional |
System.Management.Automation.SwitchParameter |
The BypassAdditionalDomainValidation switch specifies
that the command skip validation of domains from the external
Exchange organization. We recommend that you only use this
parameter when retrieving federation information in a hybrid
deployment between on-premises and Exchange Online organizations
that are part of a single, larger Exchange deployment. Don't use
this parameter when retrieving federation information from external
Exchange organizations in a cross-organization arrangement. The
default value is |
|
Force |
Optional |
System.Management.Automation.SwitchParameter |
The Force switch specifies that the command overrides the prompt and fail immediately if the host name in the Autodiscover endpoint of the domain doesn't match the Secure Sockets Layer (SSL) certificate presented by the endpoint, and the host name isn't specified in the TrustedHostnames parameter. |
|
TrustedHostnames |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The TrustedHostnames parameter specifies the fully qualified domain name (FQDN) of federation endpoints. Federation endpoints are Client Access servers in an organization with federation enabled. Explicitly specifying the TrustedHostnames parameter allows the cmdlet to bypass prompting if the certificate presented by the endpoint doesn't match the domain name specified in the DomainName parameter. |
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.