New-CsAllowedDomain

Syntax

New-CsAllowedDomain
   [-Identity] <XdsGlobalRelativeIdentity>
   [-Comment <String>]
   [-MarkForMonitoring <Boolean>]
   [-ProxyFqdn <String>]
   [-Force]
   [-InMemory]
   [-WhatIf]
   [-Confirm]
   [-VerificationLevel <VerificationLevelType>]
   [<CommonParameters>]

New-CsAllowedDomain
   [-Comment <String>]
   -Domain <String>
   [-MarkForMonitoring <Boolean>]
   [-ProxyFqdn <String>]
   [-Force]
   [-InMemory]
   [-WhatIf]
   [-Confirm]
   [-VerificationLevel <VerificationLevelType>]
   [<CommonParameters>]

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 Skype for Business. Skype for Business Server 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 servers running the Skype for Business Server Access Edge service 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 establish 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 Skype for Business Server.

If you want to create a new federation relationship, you can use the New-CsAllowedDomain cmdlet to add a domain to the list of allowed domains.

Examples

-------------------------- EXAMPLE 1 --------------------------

New-CsAllowedDomain -Identity "fabrikam.com"

In Example 1, the domain fabrikam.com is added to the list of allowed domains. To do this, the New-CsAllowedDomain cmdlet is called, along with the Identity parameter; this parameter is assigned the name of the domain to be added to the allowed list. Note that this command will fail if fabrikam.com is already on the allowed list or on the blocked list.

-------------------------- EXAMPLE 2 --------------------------

New-CsAllowedDomain -Identity "fabrikam.com" -ProxyFqdn "proxyserver.fabrikam.com" -MarkForMonitoring $True -Comment "Contact: Ken Myer (kenmyer@fabrikam.com)"

Example 2 is a variation of the command shown in Example 1. In this case, however, two additional parameters are included along with Identity: ProxyFqdn is used to specify the FQDN of the proxy server for fabrikam.com, and MarkForMonitoring is used to add this federation connection to the list of items monitored by Monitoring Server.

-------------------------- EXAMPLE 3 --------------------------

$x = New-CsAllowedDomain -Identity "fabrikam.com" -InMemory

$x.ProxyFqdn = "proxyserver.fabrikam.com"

$x.MarkForMonitoring = $True

$x.Comment = "Contact: Ken Myer (kenmyer@fabrikam.com)"

Set-CsAllowedDomain -Instance $x

Example 3 demonstrates how you can use the InMemory parameter to create a new allowed domain that initially exists only in memory. After you modify the property values of this in-memory-only domain, you can then call the Set-CsAllowedDomain cmdlet to add the domain to the allowed list.

In order to do this, the first command in the example uses the New-CsAllowedDomain cmdlet and the InMemory parameter to create an allowed domain that has the Identity fabrikam.com. After that, the virtual domain is stored in the variable $x.

Lines 2, 3, and 4 are used to modify the values of the ProxyFqdn, MarkForMonitoring, and Comment properties, respectively. After all of the property values have been modified, the final command uses the Set-CsAllowedDomain cmdlet to add the virtual domain to the allowed domain list. Keep in mind that, until the Set-CsAllowedDomain cmdlet is called, fabrikam.com exists only in memory: if you run the Get-CsAllowedDomain cmdlet any time prior to the last line in the example, fabrikam.com will not appear on the list of allowed domains. Fabrikam.com will not show up on the allowed list until after you have called the Set-CsAllowedDomain cmdlet.

Parameters

-Comment

-Confirm

-Domain

-Force

-Identity

-InMemory

-MarkForMonitoring

-ProxyFqdn

-VerificationLevel

-WhatIf

Inputs

None. The New-CsAllowedDomain cmdlet does not accept pipelined input.

Outputs

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

Related Links

• Get-CsAllowedDomain
• Remove-CsAllowedDomain
• Set-CsAccessEdgeConfiguration
• Set-CsAllowedDomain