Modifies the property values of an existing collection of Access Edge server configuration settings. Access Edge servers provide a way for users outside your internal network to communicate with users inside your internal network.
Syntax
Set-CsAccessEdgeConfiguration [-Identity <XdsIdentity>] [-AllowAnonymousUsers <$true | $false>] [-AllowFederatedUsers <$true | $false>] [-AllowOutsideUsers <$true | $false>] [-Confirm [<SwitchParameter>]] [-EnableArchivingDisclaimer <$true | $false>] [-Force <SwitchParameter>] [-KeepCrlsUpToDateForPeers <$true | $false>] [-MarkSourceVerifiableOnOutgoingMessages <$true | $false>] [-OutgoingTlsCountForFederatedPartners <UInt32>] [-WhatIf [<SwitchParameter>]] |
Set-CsAccessEdgeConfiguration [-AllowAnonymousUsers <$true | $false>] [-AllowFederatedUsers <$true | $false>] [-AllowOutsideUsers <$true | $false>] [-BeClearingHouse <$true | $false>] [-Confirm [<SwitchParameter>]] [-EnableArchivingDisclaimer <$true | $false>] [-EnablePartnerDiscovery <$true | $false>] [-Force <SwitchParameter>] [-KeepCrlsUpToDateForPeers <$true | $false>] [-MarkSourceVerifiableOnOutgoingMessages <$true | $false>] [-OutgoingTlsCountForFederatedPartners <UInt32>] [-UseDnsSrvRouting <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Set-CsAccessEdgeConfiguration [-AllowAnonymousUsers <$true | $false>] [-AllowFederatedUsers <$true | $false>] [-AllowOutsideUsers <$true | $false>] [-Confirm [<SwitchParameter>]] [-DefaultRouteFqdn <String>] [-EnableArchivingDisclaimer <$true | $false>] [-Force <SwitchParameter>] [-IsPublicProvider <$true | $false>] [-KeepCrlsUpToDateForPeers <$true | $false>] [-MarkSourceVerifiableOnOutgoingMessages <$true | $false>] [-OutgoingTlsCountForFederatedPartners <UInt32>] [-UseDefaultRouting <SwitchParameter>] [-VerificationLevel <AlwaysVerifiable | AlwaysUnverifiable | UseSourceVerification>] [-WhatIf [<SwitchParameter>]] |
Set-CsAccessEdgeConfiguration [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-WhatIf [<SwitchParameter>]] |
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Optional |
Xds Identity |
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 Set-CsAccessEdgeConfiguration. However, if you want, you can use the following syntax to modify the global settings: -Identity global. |
Instance |
Optional |
DisplayAccessEdgeSettingsDnsSrvRouting object or DisplayAccessEdgeSettingsDefaultRoute object |
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. |
AllowAnonymousUsers |
Optional |
Boolean |
Indicates whether or not anonymous (that is, unauthenticated) users will be allowed to traverse the firewall and join meetings and conferences |
AllowFederatedUsers |
Optional |
Boolean |
Indicates whether internal users will be allowed to communicate with users from federated domains. This property also determines whether internal users can communicate with users in a split domain scenario. (In a split domain, some of your users have accounts hosted on premises, while others have accounts hosted by an in-the-cloud service.) |
AllowOutsideUsers |
Optional |
Boolean |
Indicates whether users can access Microsoft Communications Server across the Internet; this includes both anonymous users and remote users who are trying to log on to the system. |
BeClearinghouse |
Optional |
Boolean |
Indicates whether your Access Edge servers are directly connected to other organizations. |
DefaultRouteFqdn |
Optional |
Fqdn |
Fully qualified domain name of the server used for federation requests. This parameter is required if you elect to use default routing. |
EnableArchivingDisclaimer |
Optional |
Boolean |
If set to True, edge serves send an archiving notification header to federated and clearinghouse partners. This notification (which informs people that instant message conversations might be archived) can be displayed in the conversation window of a federated or clearinghouse user. |
EnablePartnerDiscovery |
Optional |
Boolean |
If True, Microsoft Communications Server will use DNS records to try and discover partner domains not listed in the AllowedDomains list. If False, Microsoft Communications Server will only federate with domains found on the AllowedDomains list. This parameter is required if you use DNS service routing. |
IsPublicProvider |
Optional |
Boolean |
Must be set to True if the default route requires a public instant messaging license. |
KeepCrlsUpToDateForPeers |
Optional |
Boolean |
Determines whether or not Access Edge servers periodically checks the certificate revocation lists (CRLs) for all federated domain certificates. |
MarkSourceVerifiableOnOutgoingMessages |
Optional |
Boolean |
If True, outgoing messages are marked as verifiable; this enables federated domains to determine the verification level for each message. If False, outgoing messages are all marked as unverifiable. |
OutgoingTlsCountForFederatedPartners |
Optional |
Integer |
Specifies the maximum number of TLS connections that can be used for each federated partner. The minimum number of TLS connections is 1, and the maximum number is 4. By default, OutgoingTlsCountForFederatedPartners is set to 4. |
UseDnsSrvRouting |
Optional |
Switch Parameter |
Indicates that Access Edge servers should rely on DNS SRV records when sending and receiving federation requests. |
VerificationLevel |
Optional |
PS List Modifier |
If you are using default routing, the VerificationLevel property is used to monitor and assess the verification level of incoming messages. Valid values are: AlwaysVerifiable - All requests received on the default route are marked as verified. If a verification header is not present it will automatically be added to the message. AlwaysUnverifiable - Messages are passed only if the addressee (the user the message is intended for) has configured an Allow ACE (access control entry) for the person who sent the message. UssseSourceVerification - Message verification is based on the verification level included with the message. If no verification header is present then the message will be marked as unverified. |
Force |
Optional |
Switch Parameter |
|
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Detailed Description
Access Edge servers (also known as access proxy servers) provide a way for you to extend the capabilities of Microsoft Communications Server 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 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 Microsoft Communications Server 2010, your Access Edge servers are managed using a single, global collection of configuration settings; the Set-CsAccessEdgeConfiguration cmdlet enables you to modify these global settings. Note that the properties that can be modified at a given time depend on the routing type you choose for your edge servers. For example, if you choose to use DNS service routing, you will see- and have the ability to change - the property values BeClearinghouse and EnablePartnerDiscovery. If you use default routing, those two property values will not be available. Instead, you will see - and have the ability to change - the property values VerificationLevel and IsPublicProvider.
Enter detail description
Return Types
Set-CsAccessEdgeConfiguration does not return any objects or values. Instead, the cmdlet configures 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 | |
---|---|
Set-CsAccessEdgeConfiguration -AllowAnonymousUsers $True -VerificationLevel "UseSourceVerification" |
In Example 1, two properties of the access Edge server configuration settings are modified: the AllowAnonymousUsers property is set to True ($True) and the VerificationLevel property is set to UseSourceVerification.
-------------------------- Example 2 ------------------------
Copy Code | |
---|---|
Set-CsAccessEdgeConfiguration -DefaultRouteFqdn "redmond-csedge-001.litwareinc.com" |
The command shown in Example 2 changes the routing method for the Access Edge server to default routing. In order to do this the command must include the -DefaultRouteFqdn parameter, along with a parameter value that specifies the fully qualified domain name of the Access Edge server.
-------------------------- Example 3 ------------------------
Copy Code | |
---|---|
Set-CsAccessEdgeConfiguration -UseDnsSrvRouting -EnablePartnerDiscovery $True |
The preceding command changes the routing method for the Access Edge server to DNS server routing. This requires the use of two parameters: -UseDnsSrvRouting (with no parameter value) and -EnablePartnerDiscovery (with the parameter value $True).