[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Returns information indicating whether your Active Directory forest has been correctly configured to allow for the installation of Microsoft Communications Server 2010.

Syntax

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

Parameters

Parameter Required Type Description

GlobalCatalog

Optional

String

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

GlobalSettingsDomainController

Optional

String

RootDomainController

Optional

String

Force

Optional

Switch Parameter

Report

Optional

String

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

Detailed Description

Before you can install Microsoft Communications Server “14” you must make a number of forest-level changes to Active Directory. This includes creating Communications Server-specific objects and display specifiers as well creating universal security groups needed to manage Microsoft Communications Server. The Get-CsAdForest cmdlet returns a single value that tells you whether or not Communications Server can be installed in a forest. If Get-CsAdForest returns the value LC_FORESTSETTINGS_STATE_READY then you can install Communications Server in the forest. If the cmdlet returns LC_FORESTSETTINGS_STATE_NOT_READY then you will need to correctly prepare the forest before trying to install Communications Server.

Get-CsAdForest runs as part of the Setup Wizard; if the Wizard determines that the domain is not correctly prepared then you will receive an error message and setup will stop. However, you can also run Get-CsAdForest independently of the Setup Wizard, giving you the opportunity to verify the forest status before you try to install Communications Server.

Get-CsAdForest performs the same function as the following Office Communications Server 2007 R2 command: Lcscmd.exe /forest /action:CheckForestPrepState.

Return Types

Get-CsAdForest returns instances of the Microsoft.Rtc.Management.Deployment.LcForestSettingsState object.

Examples

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

Copy Code
Get-CsAdForest

The preceding example returns information indicating whether your Active Directory forest has been correctly configured to allow for the installation of Microsoft Communications Server.

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

Copy Code
Get-CsAdForest -Report C:\Forest_State.html

In Example 2, forest state information is returned and the forest readiness displayed onscreen. In addition to that, detailed information about the steps taken to determine the forest state is written to a file named C:\Forest_State.html. This file (which is generated by including the -Report parameter followed by the path to the file where the information should be recorded) includes such things as a detailed list of all the Active Directory groups and Active Directory containers whose permissions were verified.