31.32 Set-DraCsUser

Synopsis

Updates the Skype properties of the user account specified by the Identifier parameter.

Syntax

Set-DraCsUser -Domain <String> [-Enabled <Boolean>] [-SipAddress <String>] [-AudioVideoDisabled <Boolean>] [-RemoteCallControlTelephonyEnabled <Boolean>] [-EnterpriseVoiceEnabled <Boolean>] [-LineURI <String>] [-LineServerURI <String>] -Identifier <String> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]

Description

The Set-DraCsUser cmdlet updates the Skype properties of the specified user account. The requesting user must have the 'Re-Enable Skype For Business for User' power to Re-Enable Skype For Business for User.

In the case of telephony the user should pass the parameters to set the correct telephony value. For example, if the user has set 'AudioVideoDisabled' to $true initially, when changing the telephony parameter to 'EnterpriseVoiceEnabled' you must pass '-AudioVideoDisabled $false' and '-EnterpriseVoiceEnabled $true'.

Parameters

Attribute / Description

Parameters / Values

Required

Position

Default Value

Accept Pipeline input?

Accept wildcard characters?

Properties <Hashtable>

A hashtable of property values. The key is the name of a defined attribute in the REST interface. For example: -Properties @{Attribute1DRADisplayName="my value"; Attribute2DRADisplayName=value}

Multiple values are specified as a comma-separated list.For example:-Properties @{Attribute1DRADisplayName=value1, value2}

If the property name contains non-alphanumeric characters it needs to be quoted.For example: -Properties @{"Attribute1-DRA-DisplayName"=value}

If the property value contains a quote it needs to be escaped with a backtick (`).For example: -Properties @{Attribute1DRADisplayName="`"sample`" value"}

true

named

 

true (ByPropertyName)

false

SipAddress [<String>]

The user's SIP address. For example: MyUserName@Mydomain.corp. The SipAddress parameter can not be used simultaneously with the SipAddressType parameter.

false

named

 

true (ByPropertyName)

false

AudioVideoDisabled [<Nullable`1>]

Setting this parameter to false, which is its default value, enables the user to make audiovisual calls via Skype for Business. Setting this parameter to true will restrict the user to sending and receiving instant messages only.

For information about setting the values of Telephony Mode, see Setting up the values for Skype telephony mode.

false

named

 

true (ByPropertyName)

false

RemoteCallControlTelephonyEnabled [<Nullable`1>]

Setting this parameter to true enables 'Remote Call Control' or 'Remote Call Control Only' for the user when 'AudioVideoDisabled' is also set to true. When enabled, the user must also specify 'LineURI' and 'LineServerURI'.

For information about setting the values of Telephony Mode, see Setting up the values for Skype telephony mode.

false

named

 

true (ByPropertyName)

false

EnterpriseVoiceEnabled [<Nullable`1>]

Setting this parameter to true enables the Enterprise Voice feature in Skype for Business, which is Microsoft's implementation of Voice over Internet Protocol (VoIP). Enabling Enterprise Voice enables users to make telephone calls over the Internet.

For information about setting the values of telephony mode, see Setting up the values for Skype telephony mode.

false

named

 

true (ByPropertyName)

false

LineURI [<String>]

Specifies the phone number assigned to the user. This parameter must be specified in E.164 format and must use the 'TEL:' prefix. For example: TEL:+12345678279. This parameter is mandatory if 'RemoteCallControlTelephonyEnabled' is set to true.

false

named

 

true (ByPropertyName)

false

LineServerURI [<String>]

The URI of the remote call control telephone gateway assigned to the user. This parameter is mandatory when 'RemoteCallControlTelephonyEnabled' is set to true. This parameter must be prefaced by 'sip:'. For example: sip:user@domain.com.

false

named

 

true (ByPropertyName)

false

Identifier <String>

The name or distinguished name of an existing Active Directory object. When the name is specified, an additional call to the DRA Server is needed to obtain the distinguished name for the object.

true

named

 

true (ByPropertyName)

false

Domain <String>

The domain of the object in FQDN format. For example: mydomain.corp

true

named

 

true (ByPropertyName)

false

DRARestServer [<String>]

The name of the computer running the DRA Rest Service. The requested DRA operation will execute on this server. If the parameter is not specified, the value defaults to 'localhost'.

false

named

 

true (ByPropertyName)

false

DRARestPort [<Int32>]

The port where the DRA REST Service listens for requests. If the parameter is not specified, the value defaults to 8755.

false

named

8755

true (ByPropertyName)

false

IgnoreCertificateErrors [<SwitchParameter>]

Allows the request to bypass any SSL certificate errors, such as the InvalidOperation error that occurs when the REST Service is bound to a self-signed certificate.

false

named

 

false

false

Force [<SwitchParameter>]

Suppresses any request for user input and supplies a 'yes' response. For example: -Force with a delete request will perform the delete without presenting the confirmation request to the user.

false

named

 

false

false

Timeout [<Int32>]

The number of seconds to wait before the request to the DRA REST server times out. To specify an infinite timeout, you can set this parameter to -1.

false

named

100 seconds

false

false

<CommonParameters>

Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see About CommonParameters.

 

 

 

 

 

Setting up the values for Skype telephony mode

Telephony Mode

EnterpriseVoiceEnabled

RemoteCallControlTelephonyEnabled

AudioVideoDisabled

PC-to-PC (default)

false

false

false

Audio/Video disabled

false

false

true

Enterprise Voice

true

false

false

Remote call control

false

true

false

Remote call control only

false

true

true

NOTE:For more information, type "Get-Help Set-DraCsUser -detailed". For technical information, type "Get-Help Set-DraCsUser -full".

Example 31-51 1

PS C:\>Set-DraCsUser -Domain MyDomain.corp -Identifier "CN=USER123,OU=Accounting,DC=MyDomain,DC=corp" -Enabled $true -AudioVideoDisabled $true

This example enables Skype for a temporarily disabled user named USER123 in MyDomain.corp. The identifier contains the distinguished name of the user. Sets 'AudioVideoDisabled' in Skype telephony.

Example 31-52 2

PS C:\>Set-DraCsUser -Domain MyDomain.corp -Identifier "CN=USER123,OU=Accounting,DC=MyDomain,DC=corp" -EnterpriseVoiceEnabled $true -LineURI "TEL:+12345678279" -AudioVideoDisabled $false

This example modifies Skype telephony for a user named USER123 in MyDomain.corp. The identifier contains the distinguished name of the user. Sets EnterpriseVoiceEnabled and LineURI to 'TEL:+12345678279'. Initially, 'AudioVideoDisabled' is set "True" in Skype telephony, so we set it to false here; otherwise passing this command will generate an error.

Example 31-53 3

PS C:\>Set-DraCsUser -Domain MyDomain.corp -Identifier "CN=USER123,OU=Accounting,DC=MyDomain,DC=corp" -Enabled $true -AudioVideoDisabled $true -RemoteCallControlTelephonyEnabled $true -LineURI "TEL:+14255551297" -LineServerURI "sip:USER123@MyDomain.corp"

This example enables Skype for a temporarily disabled user named USER123 in MyDomain.corp. The identifier contains the distinguished name for the user. Sets Remote Call Control Only (AudioVideoDisabled $true and RemoteCallControlTelephonyEnabled $true) in telephony. And LineURI as TEL:+12345678279, LineServerURI as sip:USER123@MyDomain.corp.

Example 31-54 4

PS C:\>Set-DraCsUser -Domain MyDomain.corp -Identifier "CN=USER123,OU=Accounting,DC=MyDomain,DC=corp" -Enabled $false

This example temporarily disables Skype for a user named USER123 in MyDomain.corp. The identifier contains the distinguished name for the user.