Install-CsAdServerSchema

Extends the Active Directory schema to allow for the installation of Skype for Business Server. This cmdlet was introduced in Lync Server 2010.

Syntax

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

Description

Although Skype for Business 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, Skype for Business 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 Skype for Business 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 Skype for Business 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.

Examples

-------------------------- EXAMPLE 1 --------------------------

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 --------------------------

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.

Optional Parameters

-Confirm

Prompts you for confirmation before executing the command.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-Force

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-GlobalCatalog

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.

Type:Fqdn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-GlobalSettingsDomainController

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.

Type:Fqdn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-Ldf

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 Skype for Business Server installation path recorded in the registry. The installation path will typically be C:\Program Files\Skype for Business Server\Deployment\Setup.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-Report

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-SchemaMaster

Fully qualified domain name (FQDN) of the Active Directory schema master for your domain. This parameter is not required if you are running the Install-CsAdServerSchema cmdlet on a computer with an account in your domain.

Type:Fqdn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2015
-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015

Inputs

None. The Install-CsAdServerSchema cmdlet does not accept pipelined input.

Outputs

The Install-CsAdServerSchema cmdlet does not return any values or objects.