Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Get-CsNetworkSite

 

Topic Last Modified: 2013-03-06

Retrieves one or more network sites defined for call admission control (CAC) or Enhanced 9-1-1 (E9-1-1). This cmdlet was introduced in Lync Server 2010.

Get-CsNetworkSite [-Identity <XdsGlobalRelativeIdentity>] <COMMON PARAMETERS>
Get-CsNetworkSite [-Filter <String>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-LocalStore <SwitchParameter>]

Calling the Get-CsNetworkSite cmdlet with no parameters will return all network sites configured for CAC or E9-1-1 within the Lync Server deployment.

Get-CsNetworkSite

This command retrieves the site with the Identity (and, by definition, the NetworkSiteID) Redmond.

Get-CsNetworkSite -Identity Redmond

The command in Example 3 calls the Get-CsNetworkSite cmdlet 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.

Get-CsNetworkSite -Filter NA*

Example 4 uses two cmdlets, the Get-CsNetworkSite cmdlet and the Where-Object cmdlet, to retrieve all the sites that are part of the NorthAmerica region. The command begins by calling the Get-CsNetworkSite cmdlet with no parameters to retrieve all network sites. This collection of sites is then piped to the Where-Object cmdlet, which filters the collection, looking for all sites in the collection where the NetworkRegionID property is equal to (-eq) NorthAmerica.

Get-CsNetworkSite | Where-Object {$_.NetworkRegionID -eq "NorthAmerica"}

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"}

 

Parameter Required Type Description

Filter

Optional

System.String

A wildcard string that allows you to retrieve multiple sites based on matching the site Identity to the Filter value.

Identity

Optional

Microsoft.Rtc.Management.Xds.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.)

LocalStore

Optional

System.Management.Automation.SwitchParameter

Retrieves the network site information from the local replica of the Central Management store, rather than the Central Management store itself.

Retrieves an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.