[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Returns configuration information for the A/V Edge Servers currently in use in your organization. A/V Edge Servers enable internal users to share audio and video data with external users (that is, users who are not logged on to your internal network).

Syntax


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


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

Parameters

Parameter	Required	Type	Description
Identity	Optional	XdsIdentity	Unique identifier for the collection of A/V Edge configuration settings to be retrieved. To retrieve the global collection, use the following syntax: -Identity global. To retrieve a site collection use syntax similar to this: -Identity site:Redmond. Settings configured at the service scope should be referred to using syntax similar to this: -Identity service:EdgeServer:atl-cs-001.litwareinc.com. Note that you cannot use wildcards when specifying a policy Identity. If this parameter is not included Get-CsAVEdgeConfiguration will return a collection of all the Edge configuration settings currently in use in your organization.
Filter	Optional	String	Enables you to use wildcard characters when indicating the A/V edge configuration settings to be returned. For example, to return all the settings configured at the site scope you use this syntax: -Filter site:. This works because, by definition, any policy configured at the site scope must have an Identity (the only property you can filter on) that begins with the string value "site:". To return a collection of all the settings configured at the service use this syntax: -Filter "service:".
LocalStore	Optional	Switch Parameter

Parameter

Required

Type

Description

Identity

Optional

XdsIdentity

Unique identifier for the collection of A/V Edge configuration settings to be retrieved. To retrieve the global collection, use the following syntax: -Identity global. To retrieve a site collection use syntax similar to this: -Identity site:Redmond. Settings configured at the service scope should be referred to using syntax similar to this: -Identity service:EdgeServer:atl-cs-001.litwareinc.com. Note that you cannot use wildcards when specifying a policy Identity.

If this parameter is not included Get-CsAVEdgeConfiguration will return a collection of all the Edge configuration settings currently in use in your organization.

Filter

Optional

String

Enables you to use wildcard characters when indicating the A/V edge configuration settings to be returned. For example, to return all the settings configured at the site scope you use this syntax: -Filter site:*. This works because, by definition, any policy configured at the site scope must have an Identity (the only property you can filter on) that begins with the string value "site:". To return a collection of all the settings configured at the service use this syntax: -Filter "service:*".

LocalStore

Optional

Switch Parameter

Detailed Description

A/V Edge servers provide a way for audio and video traffic to be exchanged across the corporate firewall. Among other things, this enables users to access Microsoft Communications Server 2010 across the Internet and then exchange audio and video data with users who have logged onto the system from inside the firewall. Edge server configuration settings can be assigned at the global scope, the site scope, and the service scope. (For the latter, these settings can only be applied to the Edge Server service.) The A/V Edge configuration settings enable administrators to manage the longevity of authentication tokens, and to limit the amount of bandwidth that can be used by a single user or a single port.

The Get-CsAVEdgeConfiguration cmdlet provides a way for you to retrieve information about any (or all) of the A/V Edge configuration settings currently in use in your organization.

Return Types

Get-CsAVEdgeConfiguration returns instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.Edge.MediaRelaySettings object.

Examples

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

	Copy Code
Get-CsAVEdgeConfiguration

The command shown in Example 1 returns a collection of all the A/V Edge configuration settings configured for use in the organization. Calling Get-CsAVEdgeConfiguration without any additional parameters always returns a complete collection of configuration settings.

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

	Copy Code
Get-CsAVEdgeConfiguration -Identity site:Redmond

In Example 2 a single collection of A/V Edge configuration settings is returned: the collection that has the Identity site:Redmond.

-------------------------- Example 3 ------------------------

	Copy Code
Get-CsAVEdgeConfiguration -Filter "site:*"

The preceding command returns a collection of all the A/V Edge configuration settings that have been configured at the site scope. To do this, Get-CsAVEdgeConfiguration is called along with the -Filter parameter; the filter value "site:*" limits the returned data to settings that have an Identity that begins with the characters "site:". By definition, any settings that meet that criterion are settings that configured at the site scope.

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

	Copy Code
Get-CsAVEdgeConfiguration \| Where-Object {$_.MaxBandwidthPerUserKB -gt 10000}

In Example 4, the only A/V Edge configuration settings that are returned are those where the MaxBandwidthPerUserKB property is greater than 10,000 bytes. To perform this task, the command first calls Get-CsAVEdgeConfiguration without any parameters; that returns a collection of all the A/V Edge configuration settings currently in use. This collection is then piped to the Where-Object cmdlet, which picks out only the items where the MaxBandwidthPerUserKB is greater than (-gt) 10000.

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

	Copy Code
Get-CsAVEdgeConfiguration \| Where-Object {$_.MaxTokenLifetime -lt "08:00:00"}

The command shown in Example 5 returns only the A/V Edge configuration settings where the MaxTokenLifetime property is less than 8 hours (08 hours : 00 minutes : 00 seconds). To do this, the command first calls Get-CsAVEdgeConfiguration without any parameters; this returns a collection of all A/V Edge configuration settings used in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only the items where the MaxTokenLifetime is less than (-lt) 8 hours (08:00:00).