Retrieves one or more network regions. Network regions are the network hubs or backbones in the configuration of call admission control (CAC) and E911.
Syntax
Get-CsNetworkRegion [-Identity <XdsGlobalRelativeIdentity>] [-LocalStore <SwitchParameter>] |
Get-CsNetworkRegion [-Filter <String>] [-LocalStore <SwitchParameter>] |
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. |
|
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 database, rather than the Central Management database itself. |
Detailed Description
A network region is the hub that associates a set of sites to a central site. The central site is the datacenter site on which the bandwidth policy service is running. Use this cmdlet to retrieve information about one or more network regions.
Return Types
Returns one or more objects of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Get-CsNetworkRegion |
|
Example 1 retrieves all network regions defined for the organization.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
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 --------------------------
| Copy Code |
|
|---|---|
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 --------------------------
| Copy Code |
|
|---|---|
Get-CsNetworkRegion | Where-Object {$_.CentralSite -eq "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 Communications 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) Redmond.