Share via

  • Article

Get-CsMediaConfiguration

 

Topic Last Modified: 2012-03-23

Returns information regarding media settings, including the supported level of encryption, whether Siren can be used as a voice codec by the Mediation Server in its interactions with Microsoft Lync 2010 clients, and the maximum allowed video resolution.

Syntax

Get-CsMediaConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]

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

Detailed Description

This cmdlet retrieves one or more collections of settings that define media interactions.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsMediaConfiguration cmdlet locally: RTCUniversalUserAdmins, RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsMediaConfiguration"}

Parameters

Parameter Required Type Description

Identity

Optional

XdsIdentity

The unique identifier of the media configuration 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 media configuration information from the local replica of the Central Management store, rather than from the Central Management store itself.

Input Types

None.

Return Types

Get-CsMediaConfiguration returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings object.

Example

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

Get-CsMediaConfiguration

Example 1 returns all the media configurations in use in your organization; this is done simply by invoking the cmdlet Get-CsMediaConfiguration without any additional parameters.

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

Get-CsMediaConfiguration -Identity site:Redmond1

The preceding example returns only the media configuration 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 --------------------------

Get-CsMediaConfiguration -Filter site:*

In Example 3, the Filter parameter is used to return all the media configurations at the site scope. The wildcard string site:* ensures that Windows PowerShell will return only those media configurations that have identities beginning with the string value site:.

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

Get-CsMediaConfiguration | Where-Object {$_.EncryptionLevel -eq "SupportEncryption"}

In this example, Get-CsMediaConfiguration and Where-Object are used to return all the media configurations that support (but do not require) encryption. To do this, the command first uses Get-CsMediaConfiguration to retrieve all the media configurations 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 configurations where the EncryptionLevel property is equal to (-eq) SupportEncryption.

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

Get-CsMediaConfiguration -Filter *:*med*

This example retrieves all media configurations defined for sites and services with names that 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.