Topic Last Modified: 2010-10-01

Creates a new Kerberos account used for Internet Information Services (IIS) authentication.

Syntax

New-CsKerberosAccount -UserAccount <String> [-Confirm [<SwitchParameter>]] [-ContainerDN <String>] [-Force <SwitchParameter>] [-Report <String>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

ContainerDN

Optional

Active Directory distinguished name

Distinguished name of the Active Directory container where the new account is to be created. For example: -ContainerDN "ou=Finance,dc=litwareinc,dc=com". If this parameter is not specified, then New-CsKerberosAccount will create the new account in the Computers container in Active Directory.

UserAccount

Required

String

Account name for the new account, using the format domain_name\user_name. For example: -UserAccount "litwareinc\kerberostest". Note that your command will fail if the specified account already exists.

Note, too that, despite the name UserAccount, the account created by running New-CsKerberosAccount is actually a computer account, not a user account.

Force

Optional

Switch Parameter

Suppresses the display of any non-fatal error message that might occur when running the command.

Report

Optional

String

Enables you to specify a file path for the log file created when the cmdlet runs. For example: -Report "C:\Logs\KerberosAccount.html".

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

In Microsoft Office Communications Server 2007 and Microsoft Office Communications Server 2007 R2, IIS ran under a standard user account. This had the potential to cause issues: if that password expired you could lose your Web Services, an issue that was often difficult to diagnose. To help avoid the issue of expiring passwords, Microsoft Lync Server 2010 enables you to create a computer account (for a computer that doesn’t actually exist) that can serve as the authentication principal for all the computers in a site that are running IIS. Because these accounts use the Kerberos authentication protocol, the accounts are referred to as Kerberos accounts, and the new authentication process is known as Kerberos web authentication. This enables you to manage all your IIS servers by using a single account.

To run your servers under this authentication principal, you must first create a computer account by using the New-CsKerberosAccount cmdlet; this account is then assigned to one or more sites. After the assignment has been made, the association between the account and the Lync Server 2010 site is enabled by running the Enable-CsTopology cmdlet. Among other things, this creates the required service principal name (SPN) in Active Directory Domain Services (AD DS). SPNs provide a way for client applications to locate a particular service.

Who can run this cmdlet: You must be a domain administrator in order to run the New-CsKerberosAccount cmdlet locally. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsKerberosAccount\b"}

Input Types

None. New-CsKerberosAccount does not accept pipelined input.

Return Types

New-CsKerberosAccount creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccount object.

Example

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

Copy Code 
New-CsKerberosAccount -UserAccount "litwareinc\kerberostest" -ContainerDN "cn=Computers,dc=litwareinc,dc=com"

New-CsKerberosAccountAssignment -UserAccount "litwareinc\kerberostest" -Identity "site:Redmond"
Enable-CsTopology

The commands shown in Example 1 create a new Kerberos account (litwareinc\kerberostest), and then assign that account to the Redmond site. To do this, the first command in the example creates an account with the account name "litwareinc\kerberostest". This account will be created in the Computers container in the Litwareinc.com domain. After the account has been created, the second command uses New-CsKerberosAccountAssignment to assign that Kerberos account to the Redmond site.

After you make the new account assignment, the final command calls Enable-CsTopology in order to enable the changes.

See Also