Set-CsPstnUsage
Topic Last Modified: 2012-03-25
Modifies a set of strings that identify the allowed public switched telephone network (PSTN) usages. This cmdlet can be used to add usages to the list of PSTN usages or remove usages from the list.
Syntax
Set-CsPstnUsage [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Usage <PSListModifier>] [-WhatIf [<SwitchParameter>]]
Set-CsPstnUsage [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-Usage <PSListModifier>] [-WhatIf [<SwitchParameter>]]
Detailed Description
PSTN usages are string values that are used for call authorization. A PSTN usage links a voice policy to a route. The Set-CsPstnUsage cmdlet is used to add or remove phone usages to or from the usage list. This list is global so it can be used by policies and routes throughout the Microsoft Lync Server 2010 deployment.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsPstnUsage cmdlet locally: 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 "Set-CsPstnUsage"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
XdsIdentity |
The scope at which these settings are applied. The Identity for this cmdlet is always Global. |
Instance |
Optional |
PstnUsages |
A reference to a PSTN usage object. This object must be of type PstnUsages and can be retrieved by calling Get-CsPstnUsage. |
Usage |
Optional |
PSListModifier |
Contains a list of allowable usage strings. These entries can be any string value. |
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. |
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
Input Types
Microsoft.Rtc.Management.WritableConfig.Policy.Voice.PstnUsages object. Accepts pipelined input of PSTN usage objects.
Return Types
This cmdlet does not return a value or object. Instead, it configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.PstnUsages object.
Example
-------------------------- Example 1 --------------------------
Set-CsPstnUsage -Identity global -Usage @{add="International"}
This command adds the string "International" to the current list of available PSTN usages.
-------------------------- Example 2 --------------------------
Set-CsPstnUsage -Identity global -Usage @{remove="Local"}
This command removes the string "Local" from the list of available PSTN usages.
-------------------------- Example 3 --------------------------
Set-CsPstnUsage -Usage @{remove="Local"}
The command in this example performs the exact same action as in Example 2: it removes the "Local" PSTN usage. This example shows the command without the Identity parameter specified. The only Identity available to the Set-CsPstnUsage cmdlet is the Global identity; omitting the Identity parameter defaults to Global.
-------------------------- Example 4 --------------------------
Set-CsPstnUsage -Usage @{replace="International","Restricted"}
This command replaces everything in the usage list with the values International and Restricted. All previously existing usages are removed.