Returns information about the SIP domains configured for use in your organization. SIP domains are domains authorized to send and receive SIP (Session Initiation Protocol) traffic, and are used when assigning SIP addresses to users.
Syntax
add-attachmentfilterentry -Name <String> -Type <ContentType | FileName> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
String |
Fully qualified domain name of the SIP domain to be returned (for example, fabrikam.com). If neither this parameter nor the –Filter parameter are specified then all the SIP domains authorized for use in your organization are returned. |
|
Filter |
Optional |
String |
Enables you to use wildcards when specifying the Identities of the SIP domain (or domains) to be returned. For example the filter value "*.org" returns a collection of all the authorized SIP domains that have an Identity that ends with the string value ".org". |
|
LocalStore |
Optional |
Switch Parameter |
This parameter is for testing purposes only. |
Detailed Description
In order to configure SIP addresses for your users (and thus enable them to use SIP-related software such as Microsoft Communicator) you must supply two pieces of information: a user ID (for example, Ken.Myer) and a SIP domain (for example, litwareinc.com). The SIP domains used in this SIP addresses must be domains located within your Active Directory forest; in addition, these domains must be specifically configured as domains authorized to send and receive SIP traffic. For example, supposed you have domains named litwareinc.com, fabrikam.com, and contoso.com, but only litwareinc.com has been identified as being a SIP domain. In that case, you cannot use SIP address like sip:Ken.Myer@fabrikam.com or sip:Ken.Myer@contoso.com, at least not until fabrikam.com and contoso.com has been configured as valid SIP domains (something you do by running the New-CsSipDomain cmdlet).
The Get-CsSipDomain cmdlet provides a way for you to return information about the SIP domains authorized for use in your organization. Get-CsSipDomain also identifies the default SIP domain for your organization; this is the domain that Communications Server will use, by default, if a SIP domain is not specified.
Return Types
Get-CsSipDomain returns instances of the Microsoft.Rtc.Management.Xds.SipDomain object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Get-CsSipDomain |
|
In Example 1, Get-CsSipDomain is called without any parameters; this returns information about all the SIP domains configured for use in your organization.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsSipDomain -Identity fabrikam.com |
|
The command shown in Example 2 returns information for any SIP domain that has the Identity fabrikam.com. Because SIP domain Identities must be unique, this command will never return more than a single item.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsSipDomain -Filter "f*" |
|
The preceding command uses Get-CsSipDomain and the –Filter parameter to return information about all the SIP domains that have an Identity that begins with the letter f . For example, this command would return information for domains with Identities like fabrikam.com; fabrikam.org; fabrikam-users,com; and so on.
-------------------------- Example 4 ------------------------
| Copy Code |
|
|---|---|
Get-CsSipDomain | Where-Object {$_.Default -eq $True}
|
|
The command shown in Example 4 returns information about the default SIP domain. To do this, Get-CsSipDomain is first called, without any parameters, in order to return a collection of all the SIP domains configured for use in your organization. This collection is then piped to the Where-Object cmdlet, which selects only that domain where the Default property is equal to (-eq) True ($True).