Returns information regarding media settings, including the supported level of encryption, whether Siren can be used as a voice codec by the Mediation Server, and the maximum allowed video resolution.
Syntax
Get-CsMediaConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>] |
Get-CsMediaConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
XdsIdentity |
The unique identifier of the media configuration settings you want to retrieve. This identifier specifies the scope at which this configuration is applied (global, site, or service). |
|
Filter |
Optional |
String |
This parameter filters the results of the Get operation based on the wildcard value passed to this parameter. |
|
LocalStore |
Optional |
SwitchParameter |
Retrieves the announcement information from the local replica of the Central Management database, rather than the Central Management database itself. |
Detailed Description
This commandlet retrieves one or more collections of settings that define media interactions.
Return Types
Get-CsMediaConfiguration returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings object.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Get-CsMediaConfiguration |
|
Example 1 returns a collection of all the media settings that have been configured for use in your organization; this is done simply by invoking the cmdlet Get-CsMediaConfiguration without any additional parameters.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
Get-CsMediaConfiguration -Identity site:Redmond1 |
|
The preceding example returns only the media settings collection that has the Identity site:Redmond1. Because identities must be unique, specifying an Identity ensures that you will never retrieve more than one item.
-------------------------- Example 3 --------------------------
| Copy Code |
|
|---|---|
Get-CsMediaConfiguration -Filter site:* |
|
In Example 3, the Filter parameter is used to return all of the media settings that have been configured at the site scope. The wildcard string site:* ensures that Windows PowerShell will return only those media configuration collections that have identities beginning with the string value site:.
-------------------------- Example 4 --------------------------
| Copy Code |
|
|---|---|
Get-CsMediaConfiguration | Where-Object {$_.EncryptionLevel -eq "SupportEncryption"}
|
|
In the example shown above, Get-CsMediaConfiguration and Where-Object are used to return all of the media configuration collections that support (but do not require) encryption. To do this, the command first uses Get-CsMediaConfiguration to retrieve all of the media configuration collections in use in your organization. This information is then piped to the Where-Object cmdlet, which applies a filter that restricts the returned data to those collections where the EncryptionLevel property is equal to (-eq) SupportEncryption.
-------------------------- Example 5 --------------------------
| Copy Code |
|
|---|---|
Get-CsMediaConfiguration -Filter *:*med* |
|
This example retrieves all media configurations defined for sites and services whose names contain the string "med". For example, this command will retrieve media configuration settings defined for the site medford1, the site TwoMedfordPlace, and the service MediationServer:redmond.litwareinc.com.