Creates a new network region. Network regions are the network hubs or backbones in the configuration of call admission control (CAC) and E911.
Syntax
New-CsNetworkRegion -Identity <XdsGlobalRelativeIdentity> -CentralSite <String> [-AudioAlternatePath <$true | $false>] [-BWAlternatePaths <PSListModifier>] [-BypassID <String>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-VideoAlternatePath <$true | $false>] [-WhatIf [<SwitchParameter>]] |
New-CsNetworkRegion -CentralSite <String> -NetworkRegionID <String> [-AudioAlternatePath <$true | $false>] [-BWAlternatePaths <PSListModifier>] [-BypassID <String>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-VideoAlternatePath <$true | $false>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
XdsGlobalRelativeIdentity |
A unique identifier for the newly-created network region. Regions are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that region. |
|
CentralSite |
Required |
String |
The data center site running the bandwidth policy service. This service must be enabled in order to use CAC. This service runs on the Front End Server or the Standard Edition Server. |
|
NetworkRegionID |
Required |
String |
This value is the same as the Identity. You cannot specify both an Identity and a NetworkRegionID; a value entered for one will be automatically used for both. |
|
BWAlternatePaths |
Optional |
PSListModifier |
A list of objects that contain information about whether alternate connection paths are allowed if a media request is unable to complete along the preferred path (for example, if limits on that path have been exceeded). Alternate path objects must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWAlternatePathType. You can create objects of this type by calling the New-CsNetworkBWAlternatePath cmdlet. |
|
BypassID |
Optional |
String |
A globally unique identifier (GUID). This GUID is used to map network regions to media bypass settings within a CAC or E911 network configuration. (Use this BypassID value in the call to New-CsNetworkMediaBypassConfiguration.) If you do not specify a value for this parameter, a value will be automatically generated. If you do specify a value, it must be in the format of a GUID (for example, 3b24a047-dce6-48b2-9f20-9fbff17ed62a). Auto-generation is recommended. |
|
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
|
Description |
Optional |
String |
A string that describes the region. This parameter can be used to provide a more descriptive explanation of what the region is for than can be expressed by the Identity alone. |
|
Force |
Optional |
SwitchParameter |
|
|
InMemory |
Optional |
SwitchParameter |
Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet. |
|
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Detailed Description
A network region is the hub that associates a set of sites with a central site. The central site is the datacenter site on which the CAC bandwidth policy service is running. Use this cmdlet to create a new network region. The parameters of this cmdlet allow you to provide settings that determine whether alternate paths are allowed for audio and video connections and to associate the sites within the region with a media bypass configuration.
Return Types
Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
New-CsNetworkRegion -Identity NorthAmerica -Description "All North American Locations" -CentralSite Redmond-NA-MCS |
|
In this example a new network region named NorthAmerica is created. The region name is specified as the value for the Identity parameter. A value is also specified for the optional Description parameter, describing this region as being comprised of "All North American Locations." Finally, the CentralSite parameter receives a value of the name of the central site for this region, Redmond-NA-MCS.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
$a = New-CsNetworkBWAlternatePath -BWPolicyModality "video" -AlternatePath $false New-CsNetworkRegion -Identity EMEA -CentralSite Dublin-EU-MCS -BWAlternatePaths $a |
|
This example creates a new network region named EMEA that includes settings for an alternate path. The first line in the example calls the New-CsNetworkBWAlternatePath cmdlet to create a new alternate path. An alternate path has only two properties: BWPolicyModality, which must be set to either audio or video (video in this example); and AlternatePath, which must be either True or False (False [$false] in this example). We assign the output from this cmdlet, a reference to the alternate path object just created, to the variable $a.
In line 2 of this example we use this newly-created alternate path when we create a new network region. To do this we call New-CsNetworkRegion, passing an Identity of EMEA. We assign a value for the required parameter CentralSite (in this example the name of the central site for this region is Dublin-EU-MCS), then we specify the BWAlternatePaths parameter, passing it the variable ($a) containing the alternate path object we just create.