Modifies the description or display name properties for any of your Microsoft Communications Server 2010 sites. Sites represent a collection of Communications Server 2010 pools and are typically designed around geographic regions. Communications Server includes two types of sites: data center sites and remote sites (branch office).
Syntax
Set-CsSite [-Identity <XdsGlobalRelativeIdentity>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-DisplayName <String>] [-FederationRoute <String>] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Xds Identity |
Name of the site to be modified; for example: -Identity "Redmond". Do not use the format "site:Redmond" when specifying the identity. |
|
DisplayName |
Optional |
String |
Friendly name for the site. For example: -DisplayName "North America and South America". |
|
FederationRoute |
Optional |
String |
|
|
Description |
Optional |
String |
Enables administrators to add extra information to a site object. For example, the Description might include contact information for the site. |
|
Confirm |
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
Microsoft Communications Server 2010 introduces a new concept to the Communications Server topology: sites. Sites (which should not be confused with Active Directory sites or Microsoft Exchange Server sites) are a collection of Communications Server pools and servers that are typically organized according to geography and network bandwidth. For example, if all your computers in Redmond are located on the same local area network with high-speed, low-latency connections, you might designate a Redmond site that encompasses all those computers. If your computers in Dublin are located on their own local area network, and share high-speed, low-latency connections, then you might create a separate Dublin site as well. Sites also play a key role in Communications Server management: most policies and settings can be configured at the site scope, making it easy to, say, apply one set of dial plans to users in Redmond and a completely different set of dial plans to users in Dublin.
Sites are created using the Topology Builder, and any changes to the site infrastructure (for example, adding new pools) must also be made using Topology Builder. However, you can use the Set-CsSite cmdlet to change the display name and/or the description of any site in your organization.
Return Types
Set-CsSite does not return any objects or values. Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.Deploy.Internal.Site+CentralSite object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Set-CsSite -Identity Redmond -Description "Full-time employees in Redmond, WA." |
|
The command shown in Example 1 modifies the Description property for the Redmond site (-Identity Redmond).
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Set-CsSite -Identity Redmond -DisplayName "US Headquarters" |
|
The preceding command changes the DisplayName for the Redmond site to "US Headquarters".
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsSite | Where-Object {$_.Description -eq $Null} | ForEach-Object {Set-CsSite $_.Identity -Description "Litwareinc.com"}
|
|
The command shown in Example 3 locates all the sites that do not have a Description, then assigns each of those sites the generic description "Litwareinc.com." To do this, the command first calls Get-CsSite without any parameters in order to return a collection of all the Communications Server sites. The returned collection is then piped to the Where-Object cmdlet, which picks out only those sites where the Description property is equal to (-eq) a null value ($Null). These Description-less sites are, in turn, piped to the ForEach-Object cmdlet. This cmdlet takes each item in the collection, one at a time, and uses Set-CsSite to modify the value of the Description property.
In case you’re wondering, this example uses ForEach-Object to loop through the collection of sites that do not have a Description. That collection was not piped directly to Set-CsSite, and for one simple reason: Set-CsSite does not accept pipelined input.