Set-CsUserPstnSettings

 

Topic Last Modified: 2016-04-15

Use the Set-CsUserPstnSettings cmdlet to modify an existing voice-enabled user's public switched telephone network (PSTN) settings.

Set-CsUserPstnSettings -Identity <UserIdParameter> [-AllowInternationalCalls <$true | $false>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-HybridPSTNSite <String>] [-Tenant <Guid>] [-WhatIf [<SwitchParameter>]]

This example modifies the specified user's PSTN settings to allow international calls.

Set-CsUserPstnSettings -Identity jphillips@contoso.com -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" -AllowInternationalCalls $true

Hybrid PSTN sites are created, retrieved, modified, and deleted by the CsHybridPSTNSite cmdlet group (New, Get, Set, and Remove .) The hybrid PSTN sites can be reviewed in your hybrid configuration by using the Get-CsTenantHybridConfiguration cmdlet. However, you can't create or modify hybrid PSTN sites through the CsTenantHybridConfiguration cmdlets, you must use the CsHybridPSTNSite cmdlets to manage hybrid PSTN sites.

To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has been assigned to (including any custom RBAC roles you have created), run the following command:

Get-CsAdminRole | Where-Object {$_.Cmdlets -Match "<DesiredCmdletName>"}

 

Parameter Required Type Description

Identity

Required

Microsoft.Rtc.Management.AD.UserIdParameter

Specifies the identity of the target user. Acceptable values include:

  • User Principal Name (UPN)

    Example: jphillips@contoso.com

  • SIPAddress

    Example: sip:jphillips@contoso.com

  • GUID

    Example: 98403f08-577c-46dd-851a-f0460a13b03d

AllowInternationalCalls

Optional

System.Boolean

If set to $true, the user is enabled for international calls. If $false, international calls are not enabled. The default is $false.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing, and requires confirmation to proceed.

Force

Optional

System.Management.Automation.SwitchParameter

The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required.

HybridPSTNSite

Optional

System.String

Specifies the identity (name) of the hybrid public switched telephone network (PSTN) site that provides PSTN services for the user. Set HybridPSTNSite to $null to revert to the default PSTN site.

Tenant

Optional

System.Guid

Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308".

You can find the tenant ID for your Skype for Business Online tenants by running this command: Get-CsTenant | Select-Object DisplayName, TenantID

If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will be determined by your connection and credentials. The Tenant parameter is primarily for use in a hybrid deployment.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes.

The Set-CsUserPstnSettings cmdlet returns instances of the UserPstnSettings object.

 
Show: