Topic Last Modified: 2010-10-01

Extends the Active Directory schema to allow for the installation of Microsoft Lync Server 2010.

Syntax


`Install-CsAdServerSchema [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-GlobalCatalog <Fqdn>] [-GlobalSettingsDomainController <Fqdn>] [-Ldf <String>] [-Report <String>] [-WhatIf [<SwitchParameter>]]`

Parameters

Parameter	Required	Type	Description
GlobalCatalog	Optional	String	Fully qualified domain name (FQDN) of a global catalog server in your domain. This parameter is not required if you are running Install-CsAdServerSchema on a computer with an account in your domain.
GlobalSettingsDomainController	Optional	String	FQDN of a domain controller in your domain. This parameter is not required if you are running Install-CsAdServerSchema on a computer with an account in your domain.
Ldf	Optional	String	Path to the folder containing the .LDF file to be imported; the .LDF (LDAP Data Interchange Format) file contains the required updates for the Active Directory schema. If this parameter is not included, Install-CsAdServerSchema will look for the file in the Lync Server 2010 installation path recorded in the registry. The installation path will typically be C:\Program Files\Microsoft Lync Server 2010\Deployment\Setup.
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\ServerSchema.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

Although Lync Server 2010 stores most of its configuration information in its own database, the software also relies on Active Directory Domain Services (AD DS) as a storage location; for example, user-related information is stored as part of the user’s Active Directory account. In order to do this, Lync Server 2010 must store these values in attributes that are not part of the typical Active Directory user account. In turn, that means you must "extend" your Active Directory schema: the schema must be modified to add custom attributes (and other items) required by Lync Server 2010.

The easiest way to extend the Active Directory schema is to use the Install-CsAdServerSchema cmdlet. Install-CsAdServerSchema is typically run as part of the Lync Server 2010 setup process but, if need be, administrators can run the cmdlet at any time. After the cmdlet finishes running, you can then use Get-CsAdServerSchema to verify that the schema has been updated and that Active Directory is ready for the next step in the installation process.

Note that, when Install-CsAdServerSchema runs, the cmdlet must have access to the Schema Master, the operations master role that manages Active Directory object and attribute definitions. If you are running Install-CsAdServerSchema on a computer other than the Schema Master, the computer that hosts the Schema Master must allow remote access to the registry. If it does not, then you must run Install-CsAdServerSchema on the Schema Master itself.

The functions carried out by Install-CsAdServerSchema are similar to those carried out by the following Microsoft Office Communications Server 2007 R2 command:

Lcscmd.exe /forest /action:SchemaPrep /SchemaType:Server

Who can run this cmdlet: You must be an Active Directory schema administrator in the root domain and a local administrator on the schema master computer in order to run the Install-CsAdServerSchema cmdlet locally.

Input Types

None. Install-CsAdServerSchema does not accept pipelined input.

Return Types

Install-CsAdServerSchema does not return any values or objects.

Example

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

	Copy Code
Install-CsAdServerSchema

The command shown in Example 1 determines the location of the .LDF file by reading information from the registry, then uses that file to update the Active Directory schema.

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

	Copy Code
Install-CsAdServerSchema -Ldf "C:\Schemas"

In Example 2, the Active Directory schema is updated with information taken from a schema update file located in the folder C:\Schemas. This folder location is specified by using the Ldf parameter.