Get-CsNetworkRegion
Topic Last Modified: 2012-03-23
Retrieves one or more network regions. Network regions represent network hubs or backbones in an enterprise network.
Syntax
Get-CsNetworkRegion [-Identity <XdsGlobalRelativeIdentity>] [-LocalStore <SwitchParameter>]
Get-CsNetworkRegion [-Filter <String>] [-LocalStore <SwitchParameter>]
Detailed Description
A network region interconnects various parts of a network across multiple geographic areas. Every network region must be associated with a central site. Use this cmdlet to retrieve information about one or more network regions, including the associated central site and settings that determine whether alternate paths are allowed for audio and video connections, and that associate the sites within the region with a media bypass configuration.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsNetworkRegion 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-CsNetworkRegion"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
XdsGlobalRelativeIdentity |
The unique identifier of the network region you want to retrieve. The Identity will be in the form of a string that uniquely identifies that region. (Note that the Identity is the same as the NetworkRegionID.) |
Filter |
Optional |
String |
This parameter allows you to perform a wildcard search on the Identity of all network regions configured for the organization. Use the wildcard character to filter on any part of the Identity. |
LocalStore |
Optional |
SwitchParameter |
Retrieves the network region information from the local replica of the Central Management store, rather than the Central Management store itself. |
Input Types
None.
Return Types
Returns one or more objects of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType.
Example
-------------------------- Example 1 --------------------------
Get-CsNetworkRegion
Example 1 retrieves all network regions defined for the organization.
-------------------------- Example 2 --------------------------
Get-CsNetworkRegion -Identity NorthAmerica
Example 2 retrieves the network regions with the Identity NorthAmerica. Because identities are unique, this command retrieves at most one network region.
-------------------------- Example 3 --------------------------
Get-CsNetworkRegion -Filter *America
This example retrieves all network regions with identities that end with the string "America." This would retrieve regions with identities such as NorthAmerica, SouthAmerica, and CentralAmerica.
-------------------------- Example 4 --------------------------
Get-CsNetworkRegion | Where-Object {$_.CentralSite -eq "site:Redmond"}
This example retrieves all network regions associated with the central site Redmond. The command begins by calling the Get-CsNetworkRegion cmdlet, with no parameters, to retrieve a collection of all network regions defined for the Microsoft Lync Server 2010 deployment. This collection is then piped to the Where-Object cmdlet. Where-Object filters this collection to return only those items (network regions) where the CentralSite value is equal to (-eq) site:Redmond.