[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Modifies Microsoft Communications Server 2010 properties for an existing user account. Properties can be modified only for accounts that have been enabled for use with Communications Server 2010.

Syntax


Set-CsUser -Identity <UserIdParameter> [-AcpInfo <MultiValuedProperty>] [-AudioVideoDisabled <$true \| $false>] [-Confirm [<SwitchParameter>]] [-CSEnabled <$true \| $false>] [-DomainController <Fqdn>] [-EnterpriseVoiceEnabled <$true \| $false>] [-HostedVoiceMail <Nullable>] [-IPPBXSoftPhoneRoutingEnabled <$true \| $false>] [-LineServerURI <String>] [-LineURI <String>] [-PassThru <SwitchParameter>] [-PrivateLine <String>] [-RemoteCallControlTelephonyEnabled <$true \| $false>] [-SipAddress <String>] [-WhatIf [<SwitchParameter>]]

Set-CsUser -Identity <UserIdParameter> [-AcpInfo <MultiValuedProperty>] [-AudioVideoDisabled <$true | $false>] [-Confirm [<SwitchParameter>]] [-CSEnabled <$true | $false>] [-DomainController <Fqdn>] [-EnterpriseVoiceEnabled <$true | $false>] [-HostedVoiceMail <Nullable>] [-IPPBXSoftPhoneRoutingEnabled <$true | $false>] [-LineServerURI <String>] [-LineURI <String>] [-PassThru <SwitchParameter>] [-PrivateLine <String>] [-RemoteCallControlTelephonyEnabled <$true | $false>] [-SipAddress <String>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter	Required	Type	Description
Identity	Required	XdsIdentity	Indicates the Identity of the user account to be modified. User Identities can be specified using one of four formats: 1) The user's SIP address; 2) the user's Universal Principal Name; 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory Domain Services display name (for example, Ken Myer). Note that the SAMAccountName cannot be used as an identity because it is not necessarily unique in a forest. You can use the asterisk () wildcard character when using the Display Name as the user Identity. For example, the Identity " Smith" would return all the users with the last name Smith.
PrivateLine	Optional	String	The phone number for the user's private telephone line. A private line is a phone number that is not published in Active Directory Domain Services, and thus is not readily available to other people. In addition, this private line bypasses most in-bound call routing rules; for example, a call to a private line will not be forwarded to a person's delegates. Private lines are often used for personal phone calls or for business calls that should be kept separate from other team members. The private line should be specified using the E.164 format, and be prefixed by the "TEL:" prefix. For example: TEL:+14255551297.
HostedVoiceMail	Optional	Boolean	Indicates whether or not the user can access voice mail using Microsoft Communicator "14".
CSEnabled	Optional	Boolean	Indicates whether or not the user has been enabled for Communications Server. If you set this value to False ($False), the user will no longer be able to log on to Communications Server; setting this value to True ($True) re-enables the user's logon privileges. If you disable an account by using the CSEnabled parameter, the information associated with that account (including assigned policies and whether or not the user is enabled for Enterprise Voice, remote call control, and/or voice mail integration) is retained. If you later re-enable the account using the CSEnabled parameter, the associated account information will be restored. This differs from using the cmdlet Disable-CsUser to disable a user account. When you run Disable-CsUser, all the Communications Server data associated with that account is deleted.
IPPBXSoftPhoneRoutingEnabled	Optional	Boolean	Indicates whether telephone calls made by the user are routed through a private branch exchange (PBX) system. PBX systems are used to connect the internal telephones of an organization. For example, if a user can phone a colleague by dialing his extension (as opposed to his complete phone number), then that user is likely using a PBX system. When a user is enabled for PBX soft phone routing, that user can make and receive phone calls using either their desktop phone or Communicator. To be enabled for PBX soft phone routing, a user must also be enabled for unified communications and have a line URI.
LineServerURI	Optional	String	The URI of the remote call control telephone gateway assigned to the user. The LineServerUri is the gateway URI, prefaced by "sip:". For example: sip:rccgateway@litwareinc.com
LineURI	Optional	String	The line URI should be specified using the E.164 format, and be prefixed by 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.
RemoteCallControlTelephonyEnabled	Optional	Boolean	Indicates whether the use has been enabled for remote call control telephony. When enabled for remote call control, a user can employ Communications Server to answer phone calls made to her desk phone. Phone calls can also be made using Communicator. These calls all rely on the standard telephone network, which is also known as the public switched telephone network (PSTN). To make and receive phone calls over the Internet, the user must be enabled for Enterprise Voice. For details, see the parameter -EnterpriseVoiceEnabled. To be enabled for remote call control, a user must have both a LineUri and a LineServerUri.
AudioVideoDisabled	Optional	Boolean	Indicates whether the user is allowed to make A/V calls using Communicator "14". If set to False, the user will be largely 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 IPPBX soft phone routing.
SipAddress	Optional	String	Unique identifier (similar to an email address) that allows the user to communicate using SIP devices such as Communicator "14". The SIP address for a user is often (but does not have to be) the user’s email address, prefaced by "sip:". For example, the user with the e-mail address kenmyer@litwareinc.com might have this SIP address: sip:kenmyer@litwareinc.com.
EnterpriseVoiceEnabled	Optional	Boolean	Indicates whether the user has been enabled for unified communications. In effect, this indicates whether the user has been enabled for Enterprise Voice, Microsoft’s implementation of Voice over Internet Protocol (VoIP). With Enterprise Voice, users can use make telephone calls using the Internet rather than using the standard telephone network.
ACPInfo	Optional	Array of ACPInfo objects	Enables you to assign one or more third-party Audio Conferencing Providers to a user. Audio Conferencing Providers enable users to conduct audio-only conferences with people both inside and outside the organization. Before you can assign an Audio Conferencing Provider to a user that provider must be created using the New-CsACPInfo cmdlet. See the New-CsACPInfo help topic for more information.
DomainController	Optional	String
PassThru	Optional	Switch Parameter
WhatIf	Optional	Switch Parameter	Describes what would happen if you executed the command without actually executing the command.
Confirm	Optional	Switch Parameter	Prompts you for confirmation before executing the command.

Detailed Description

Set-CsUser enables you to modify the Communications Server-related user account attributes that are stored in Active Directory. For example, you can disable or re-enable a user for Communications Server; enable or disable a user for audio/video (A/V) communications, and modify a user’s private line and line Uniform Resource Identifier (URI) numbers. Set-CsUser can be used only for users who have already been enabled for Communications Server. For instance, user Ken Myer was enabled for Communications Server, and then his account was disabled using Set-CsUser. In this case, you can employ Set-CsUser to re-enable Ken’s account. However, suppose user Pilar Ackerman has never been enabled for Communications Server. In this case, Cs-User cannot be used to enable Pilar’s account. Instead, you must use the Enable-CsUser cmdlet to enable Pilar’s account.

You can modify only attributes related to Communications Server-related attributes. Other user account attributes, such as the user’s job title or department, cannot be modified by using this cmdlet.

Return Types

Examples

-------------------------- Example 1 --------------------------

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

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

-------------------------- Example 2 --------------------------

	Copy Code
Get-CsUser -LdapFilter "Department=Finance" \| Set-CsUser -EnterpriseVoiceEnabled $True

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