Get-CsNetworkSite
Topic Last Modified: 2012-03-23
Retrieves one or more network sites defined for call admission control (CAC) or Enhanced 9-1-1 (E9-1-1).
Syntax
Get-CsNetworkSite [-Identity <XdsGlobalRelativeIdentity>] [-LocalStore <SwitchParameter>]
Get-CsNetworkSite [-Filter <String>] [-LocalStore <SwitchParameter>]
Detailed Description
Network sites are the offices or locations configured within each region of a CAC or E9-1-1 deployment. This cmdlet retrieves the settings for one or more existing sites.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsNetworkSite 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-CsNetworkSite"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
XdsGlobalRelativeIdentity |
The unique identifier of the network site you want to retrieve. Sites are created only at the global scope, so you do not need to specify a scope. Instead, you need to specify only the site ID. (Note that this is the same value as the NetworkSiteID for the network site.) |
Filter |
Optional |
String |
A wildcard string that allows you to retrieve multiple sites based on matching the site Identity to the Filter value. |
LocalStore |
Optional |
SwitchParameter |
Retrieves the network site information from the local replica of the Central Management store, rather than the Central Management store itself. |
Input Types
None.
Return Types
Retrieves an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType.
Example
-------------------------- Example 1 --------------------------
Get-CsNetworkSite
Calling Get-CsNetworkSite with no parameters will return all network sites configured for CAC or E9-1-1 within the Microsoft Lync Server 2010 deployment.
-------------------------- Example 2 --------------------------
Get-CsNetworkSite -Identity Redmond
This command retrieves the site with the Identity (and, by definition, the NetworkSiteID) Redmond.
-------------------------- Example 3 --------------------------
Get-CsNetworkSite -Filter NA*
The command in Example 3 calls Get-CsNetworkSite with the Filter parameter. The value of the Filter parameter is NA*, meaning that this command will retrieve all sites with an Identity beginning with the string NA and followed by any number of characters. This will return sites such as NARedmond, NAVancouver, and NAChicago.
-------------------------- Example 4 --------------------------
Get-CsNetworkSite | Where-Object {$_.NetworkRegionID -eq "NorthAmerica"}
Example 4 uses two cmdlets, Get-CsNetworkSite and Where-Object, to retrieve all the sites that are part of the NorthAmerica region. The command begins by calling Get-CsNetworkSite with no parameters to retrieve all network sites. This collection of sites is then piped to Where-Object, which filters the collection, looking for all sites in the collection where the NetworkRegionID property is equal to (-eq) NorthAmerica.