This cmdlet can return an object containing the default settings for a routing configuration object.
Syntax
New-CsRoutingConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-Route <PSListModifier>] [-WhatIf [<SwitchParameter>]] |
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
XdsIdentity |
The scope of the routing configuration. This value must be Global. |
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
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. |
Route |
Optional |
PSListModifier |
A list of all voice routes (Microsoft.Rtc.Management.WriteableConfig.Policy.Voice.Route objects) defined for the Communications Server deployment. You can create voice route objects by using the New-CsVoiceRoute cmdlet. That is the recommended way of adding voice routes to this list. |
Force |
Optional |
SwitchParameter |
Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Detailed Description
A routing configuration is a container for all voice routes defined within a Microsoft Communications Server 2010 deployment. To create a new voice route, use the New-CsVoiceRoute cmdlet.
A routing configuration can be defined only at the global level. In addition, you cannot have individually named routing configurations; there is only one voice route list for the entire Communications Server 2010 deployment. In Communications Server PowerShell, if you try to create an object that already exists by calling a cmdlet beginning with the New verb, you’ll receive an error message. Every implementation of Communications Server includes a default routing configuration object with a Global Identity. What this means is that the only voice route list that could be created already exists. So a call to New-CsRoutingConfiguration will always return an error message and will not create a new routing configuration.
The only exception to this is if you specify the InMemory parameter in the call to this cmdlet. This command will create an object only in memory that contains a default list of voice routes.
Available scope: Global
Return Types
Can create an in-memory object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.PstnRoutingSettings.
Examples
-------------------------- Example 1 --------------------------
Copy Code | |
---|---|
$x = New-CsRoutingConfiguration -Identity global -InMemory |
This command creates an object containing the default routing configuration values and assigns that object to the variable $x. Any other use of this cmdlet will return an error.