Returns information about the Access Edge server configuration settings currently in use in your organization. Access Edge servers provide a way for users outside your internal network to communicate with users inside your internal network.
Syntax
Get-CsAccessEdgeConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>] |
Get-CsAccessEdgeConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
XdsIdentity |
Unique identifier of the Access Edge configuration settings to be returned. Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling Get-CsAccessEdgeConfiguration. However, if you want, you can use the following syntax to retrieve the global settings: -Identity global. |
|
Filter |
Optional |
String |
Enables you to use wildcards when specifying the Access Edge configuration settings to be returned. Because you can only have a single, global instance of these settings there is little reason to use the -Filter parameter. However, if you want, you can use the syntax similar to this to retrieve the global settings: -Identity "g*". |
|
Tenant |
Optional |
GUID |
This parameter is for testing purposes only. |
|
LocalStore |
Optional |
Switch Parameter |
This parameter is for testing purposes only. |
Detailed Description
Access Edge servers (also known as access proxy servers) provide a way for you to extend the capabilities of Microsoft Communications Server 2010 to people who are not logged on to your internal network. For example, if you have remote users - authenticated users who log on to Communications Server 2010 over the Internet rather than through the internal network - you will need to set up an Access Edge server. Likewise, edge servers are required if you want to establish federation with another organization, or if you want to give your users the right to communicate with people who have accounts with a public instant messaging service such as Yahoo!, AOL, or Windows Live. Access Edge servers sit on the perimeter network, and are used to make and validate SIP connections between users inside and users outside your internal network.
In Communications Server, your Access Edge servers are managed using a single, global collection of configuration settings; the Get-CsAccessEdgeConfiguration cmdlet enables you to return information about these global settings. Note that the property values returned by Get-CsAccessEdgeConfiguration will vary depending on the type of routing you have configured for your edge servers. For more information, see the help topic Set-CsAccessEdgeConfiguration.
Return Types
Get-CsAccessEdgeConfiguration returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayAccessEdgeSettingsDnsSrvRouting object or the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayAccessEdgeSettingsDefaultRoute object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Get-CsAccessEdgeConfiguration |
|
Example 1 demonstrates the basic use of Get-CsAccessEdgeConfiguration: calling the cmdlet without any additional parameters returns all the property values for your Access Edge server implementation. Note that there is no need to include the -Identity or -Filter parameters; that’s because there is only one set of Access Edge server configuration data to be returned.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsAccessEdgeConfiguration | Select-Object Allow* |
|
The preceding command returns just three property values for your Access Edge server configuration: AllowAnonymousUsers; AllowFederatedUsers; and AllowOutsideUsers. To do this, the command first uses Get-CsAccessEdgeConfiguration to return all the Access Edge server property values. This information is then piped to the Select-Object cmdlet, which picks out only those properties that start with the string value "Allow". In turn, those are the only property values displayed onscreen.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
(Get-CsAccessEdgeConfiguration).EnablePartnerDiscovery |
|
The command shown in Example 3 returns the value of a single Access Edge server configuration property: EnablePartnerDiscovery. To do this, Get-CsAccessEdgeConfiguration is first called in order to return all the Access Edge server configuration property values. This call to Get-CsAccessEdgeConfiguration is enclosed in parentheses; this ensures that PowerShell completes this command before doing anything else. After all the property values have been returned, standard "dot notation" (PowerShell object name followed by a period followed by a property name) is used to display the value of a single property: EnablePartnerDiscovery.