Set-CsPstnUsage

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. This cmdlet was introduced in Lync Server 2010.

Syntax

Set-CsPstnUsage
   [[-Identity] <XdsIdentity>]
   [-Usage <PSListModifier>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CsPstnUsage
   [-Instance <PSObject>]
   [-Usage <PSListModifier>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

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 Skype for Business Server deployment.

Examples

-------------------------- 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 the command 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.

Optional Parameters

-Confirm

Prompts you for confirmation before executing the command.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-Force

Suppresses any confirmation prompts that would otherwise be displayed before making changes.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-Identity

The scope at which these settings are applied. The Identity for this cmdlet is always Global.

Type:XdsIdentity
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-Instance

A reference to a PSTN usage object. This object must be of type PstnUsages and can be retrieved by calling the Get-CsPstnUsage cmdlet.

Type:PSObject
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-Usage

Contains a list of allowable usage strings. These entries can be any string value.

Type:PSListModifier
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015

Inputs

Microsoft.Rtc.Management.WritableConfig.Policy.Voice.PstnUsages object. Accepts pipelined input of PSTN usage objects.

Outputs

This cmdlet does not return a value or object. Instead, it configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.PstnUsages object.