Get-CsAdForest

Reference

Module:: SkypeForBusiness

Applies to:: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Returns information indicating whether your Active Directory forest has been correctly configured to allow for the installation of Skype for Business Server. This cmdlet was introduced in Lync Server 2010.

Syntax

Get-CsAdForest
   [-GlobalCatalog <Fqdn>]
   [-GlobalSettingsDomainController <Fqdn>]
   [-RootDomainController <Fqdn>]
   [-Report <String>]
   [-SkipPrepareCheck <Boolean>]
   [<CommonParameters>]

Description

Before you can install Skype for Business Server 2015, you must make a number of forest-level changes to Active Directory Domain Services. This includes creating display specifiers and objects specific to Skype for Business Server 2015, creating the universal security groups that are needed to manage Skype for Business Server 2015, and granting global settings object access permissions to these groups. The Get-CsAdForest cmdlet returns a single value that tells you whether or not Skype for Business Server 2015 can be installed in a forest. If the Get-CsAdForest cmdlet returns the value LC_FORESTSETTINGS_STATE_READY then you can install Skype for Business Server 2015 in the forest. If the cmdlet returns LC_FORESTSETTINGS_STATE_NOT_READY then you need to prepare the forest before trying to install Skype for Business Server 2015.

The Get-CsAdForest cmdlet runs as part of the Setup Wizard; if the Wizard determines that the forest is not correctly prepared, then you receive an error message and Setup stops. However, you can also run the Get-CsAdForest cmdlet independently of the Setup Wizard in order to verify the forest status before you try to install Skype for Business Server 2015.

Historical Note: Get-CsAdForest performs the same function as the following Microsoft Office Communications Server 2007 R2 command:

Lcscmd.exe /forest /action:CheckForestPrepState

By default, anyone who has read permissions to Active Directory can run the Get-CsAdForest cmdlet locally. Typically all domain members have this permission.

Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Get-CsAdForest"}

Examples

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

Get-CsAdForest

Example 1 returns information indicating whether your Active Directory forest has been correctly configured to allow for the installation of Skype for Business Server.

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

Get-CsAdForest -Report C:\Logs\ForestState.html

In Example 2, forest state information is returned and the forest readiness is displayed on the screen. In addition, detailed information about the steps taken to determine the forest state is written to a file named C:\Logs\ForestState.html. This file includes a detailed list of all the Active Directory groups and Active Directory containers where permissions were verified.

Parameters

-GlobalCatalog

Fully qualified domain name (FQDN) of a global catalog server in your domain. This parameter is not required if you are running the Get-CsAdForest cmdlet on a computer with an account in your domain.

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

-GlobalSettingsDomainController

FQDN of a domain controller where global settings are stored. If global settings are stored in the System container in AD DS, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted.

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

-Report

Enables you to specify a file path for the log file created when the cmdlet runs. For example:

-Report "C:\Logs\ForestPrep.html"

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

-RootDomainController

FQDN of the root domain controller, used to create trust paths for clients that need to access resources in domains other than their own.

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

-SkipPrepareCheck

When set to True ($True), causes Get-CsAdForest to run without first doing its initial preparation checks.

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

Inputs

None

Outputs

Microsoft.Rtc.Management.Deployment.LcForestSettingsState

Jaa