See Also
Topic Last Modified: 2014-02-24
Extends the Active Directory schema to allow for the installation of Lync Server. This cmdlet was introduced in Lync Server 2010.
Syntax
Install-CsAdServerSchema [-Confirm
[<SwitchParameter>]] [-Force <SwitchParameter>]
[-GlobalCatalog <Fqdn>] [-GlobalSettingsDomainController
<Fqdn>] [-Ldf <String>] [-Report <String>]
[-SchemaMaster <Fqdn>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
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.
 Copy Code |
|
|---|---|
Install-CsAdServerSchema |
|
EXAMPLE 2
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.
| Copy Code |
|
|---|---|
Install-CsAdServerSchema -Ldf "C:\Schemas" |
|
Detailed Description
Although Lync Server stores most of its configuration information in its own database, the software also relies on Active Directory Domain Services 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 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.
The easiest way to extend the Active Directory schema is to use the Install-CsAdServerSchema cmdlet. The Install-CsAdServerSchema cmdlet is typically run as part of the Lync Server setup process but, if need be, administrators can run the cmdlet at any time. After the cmdlet finishes running, you can then use the Get-CsAdServerSchema cmdlet 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 the Install-CsAdServerSchema cmdlet 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 the Install-CsAdServerSchema cmdlet 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 the Install-CsAdServerSchema cmdlet on the schema master itself.
The functions carried out by the Install-CsAdServerSchema cmdlet 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.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
Prompts you for confirmation before executing the command. |
|
Force |
Optional |
System.Management.Automation.SwitchParameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
|
GlobalCatalog |
Optional |
Microsoft.Rtc.Management.Deploy.Fqdn |
Fully qualified domain name (FQDN) of a global catalog server in your domain. This parameter is not required if you are running the Install-CsAdServerSchema cmdlet on a computer with an account in your domain. |
|
GlobalSettingsDomainController |
Optional |
Microsoft.Rtc.Management.Deploy.Fqdn |
FQDN of a domain controller in your domain. This parameter is not required if you are running the Install-CsAdServerSchema cmdlet on a computer with an account in your domain. |
|
Ldf |
Optional |
System.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, the Install-CsAdServerSchema cmdlet will look for the file in the Lync Server installation path recorded in the registry. The installation path will typically be C:\Program Files\Microsoft Lync Server 2010\Deployment\Setup. |
|
Report |
Optional |
System.String |
Enables you to specify a file path for the log file created when the cmdlet runs. For example: -Report "C:\Logs\ServerSchema.html" |
|
SchemaMaster |
Optional |
Microsoft.Rtc.Management.Deploy.Fqdn |
FQDN for the Active Directory Schema Master. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Input Types
None. The Install-CsAdServerSchema cmdlet does not accept pipelined input.
Return Types
The Install-CsAdServerSchema cmdlet does not return any values or objects.
