Set-CsUser

 

Topic Last Modified: 2015-12-01

Modifies Skype for Business Online properties for an existing user account.

Set-CsUser -Identity <UserIdParameter> [-AcpInfo <MultiValuedProperty>] [-AudioVideoDisabled <$true | $false>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-EnterpriseVoiceEnabled <$true | $false>] [-ExchangeArchivingPolicy <Uninitialized | UseLyncArchivingPolicy | NoArchiving | ArchivingToExchange>] [-HostedVoiceMail <$true | $false>] [-LineServerURI <String>] [-LineURI <String>] [-OnPremLineURI <String>] [-PassThru <SwitchParameter>] [-PrivateLine <String>] [-RemoteCallControlTelephonyEnabled <$true | $false>] [-SipAddress <String>] [-WhatIf [<SwitchParameter>]]

In Example 1, the Set-CsUser cmdlet is used to modify the user account with the Identity Pilar Ackerman. In this case, the account is modified to enable Enterprise Voice, the Microsoft implementation of VoIP. This task is carried out by adding the EnterpriseVoiceEnabled parameter, and then setting the parameter value to $True.

Set-CsUser -Identity "Pilar Ackerman" -EnterpriseVoiceEnabled $True

In Example 2, all the users in the Finance department have their accounts enabled for Enterprise Voice. In this command, the Get-CsOnlineUser cmdlet and the LdapFilter parameter are first used to return a collection of all the users who work in the Finance department. That information is then piped to the Set-CsUser cmdlet, which enables Enterprise Voice for each account in the collection.

Get-CsOnlineUser -LdapFilter "Department=Finance" | Set-CsUser -EnterpriseVoiceEnabled $True

The Set-CsUser cmdlet enables you to modify property values for one or more Skype for Business Online user accounts; for example, you can disable or re-enable a user for Skype for Business Online. However, the only attributes you can modify using the Set-CsUser cmdlet are attributes related to Skype for Business Online. Other user account attributes, such as the user’s job title or department, cannot be modified by using this cmdlet.

 

Parameter Required Type Description

Identity

Required

Microsoft.Rtc.Management.AD.UserIdParameter

Indicates the Identity of the user account to be modified. User Identities can be specified using one of the following formats: 1) the user's SIP address; 2) the user's user principal name (UPN); or, 3) the user's Active Directory display name (for example, Ken Myer).

AcpInfo

Optional

Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty

Enables you to assign one or more third-party audio conferencing providers to a user. However, it is recommended that you use the Set-UserAcp cmdlet to assign Audio conferencing providers.

AudioVideoDisabled

Optional

System.Boolean

Indicates whether the user is allowed to make audio/visual (A/V) calls by using Skype for Business client. If set to True, the user will largely be restricted to sending and receiving instant messages.

You cannot disable A/V communications if a user is currently enabled for remote call control, Enterprise Voice, and/or Internet Protocol private branch exchange (IP-PBX) soft phone routing.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command.

DomainController

Optional

Microsoft.Rtc.Management.Deploy.Fqdn

This parameter is not used with Skype for Business Online.

Enabled

Optional

System.Boolean

Indicates whether or not the user has been enabled for Skype for Business Online. If you set this value to False, the user will no longer be able to log on to Skype for Business Online; setting this value to True re-enables the user's logon privileges.

If you disable an account by using the Enabled parameter, the information associated with that account (including assigned policies and whether or not the user is enabled for Enterprise Voice and/or remote call control) is retained. If you later re-enable the account by using the Enabled parameter, the associated account information will be restored.

EnterpriseVoiceEnabled

Optional

System.Boolean

Indicates whether the user has been enabled for Enterprise Voice, the Microsoft implementation of Voice over Internet Protocol (VoIP). With Enterprise Voice, users can make telephone calls using the Internet rather than using the standard telephone network.

ExchangeArchivingPolicy

Optional

Microsoft.Rtc.Management.ADConnect.Core.ExchangeArchivingPolicyOptionsEnum

Indicates where the user's instant messaging sessions are archived. Allowed values are:

* Uninitialized

* UseLyncArchivingPolicy

* ArchivingToExchange

* NoArchiving

HostedVoiceMail

Optional

System.Boolean

When set to True, enables a user’s voice mail calls to be routed to a hosted version of Exchange. In addition, setting this option to True enables users to directly place a call to another user’s voice mail.

LineServerURI

Optional

System.String

This parameter is not used in Skype for Business Online

LineURI

Optional

System.String

This parameter is not used in Skype for Business Online

OnPremLineURI

Optional

System.String

Specifies the phone number assigned to the user if no number is assigned to that user in the Skype for Business hybrid environment. The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "TEL:" prefix. For example: TEL:+14255551297. Any extension number should be added to the end of the line URI, for example: TEL:+14255551297;ext=51297.

Note that Skype for Business treats TEL:+14255551297 and TEL:+14255551297;ext=51297 as two different numbers. If you assign Ken Myer the line URI TEL:+14255551297 and later try to assign Pilar Ackerman the line URI TEL:+14255551297;ext=51297, that assignment will succeed. Depending on your setup, those two numbers could actually be different. For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user.

PassThru

Optional

System.Management.Automation.SwitchParameter

Enables you to pass a user object through the pipeline that represents the user whose account is being modified. By default, the Set-CsUser cmdlet does not pass objects through the pipeline.

PrivateLine

Optional

System.String

This parameter is not used in Skype for Business Online

RemoteCallControlTelephonyEnabled

Optional

System.Boolean

This parameter is not used in Lync Online.

SipAddress

Optional

System.String

Unique identifier (similar to an email address) that allows the user to communicate using SIP devices such as Skype for Business client. The SIP address must use the sip: prefix as well as a valid SIP domain; for example: -SipAddress sip:kenmyer@litwareinc.com.

WhatIf

Optional

System.Management.Automation.SwitchParameter

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

String or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. The Set-CsUser cmdlet accepts a pipelined string value representing the Identity of a user account that has been enabled for Skype for Business Server 2015. The cmdlet also accepts pipelined instances of the Active Directory user object.

The Set-CsUser cmdlet does not return any objects.

 
Show: