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

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

Syntax

Get-CsAdDomain [-Domain <Fqdn>] [-DomainController <Fqdn>] [-GlobalCatalog <Fqdn>] [-GlobalSettingsDomainController <Fqdn>] [-Report <String>]

Parameters

Parameter Required Type Description

Domain

Optional

String

Fully-qualified domain name of the domain to be checked; for example: -Domain "litwareinc.com". If this parameter is not specified then the local domain will be checked.

DomainController

Optional

String

Enables administrators to specify the fully qualified domain name of the domain controller to be used when running Get-CsAdDomain. If not specified, the cmdlet will use the first available domain controller.

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-CsAdDomain on a computer with an account in your domain.

GlobalSettingsDomainController

Optional

String

Fully qualified domain name of a domain controller where global settings are stored. If global settings are stored in the System container in Active Directory 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.

Force

Optional

Switch Parameter

Suppresses the display of any non-fatal error message that might arise 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\DomainPrep.html"

Detailed Description

Before you can install Microsoft Communications Server “14” your domain must be correctly prepared; that preparation involves extending the Active Directory schema to allow for the addition of Communications Server-specific attributes (see the help topic Get-CsAdServerSchema) as well as assigning the required Access Control Entries to the universal groups used for managing and operating Communications Server. The Get-CsAdDomain cmdlet returns a single value that tells you whether or not Communications Server can be installed on a domain. If Get-CsAdDomain returns the value LC_DOMAINSETTINGS_STATE_READY then you can install Communications Server on that domain. If the cmdlet returns LC_DOMAINSETTINGS_STATE_NOT_READY then you will need to correctly prepare the domain before trying to install Communications Server.

Get-CsAdDomain 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-CsAdDomain independently of the Setup Wizard, giving you the opportunity to verify the domain status before you try to install Communications Server.

Get-CsAdDomain performs the same function as the following Office Communications Server 2007 R2 command: Lcscmd.exe /domain /action:CheckDomainPrepState.

Return Types

Get-CsAdDomain returns instances of the Microsoft.Rtc.Management.Deployment.LcDomainSettingsState object.

Examples

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

Copy Code
Get-CsAdDomain

The preceding example returns information regarding the current status of your default Active Directory domain. If your domain settings are up-to-date, and the domain is ready to host Communications Server 2010, the value LC_DOMAIN_SETTINGS_STATE_READY will be returned.

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

Copy Code
Get-CsAdDomain -Domain "fabrikam.com" 

The command shown in Example 2 returns the current status of a specific domain: Litwareinc.com. In a multi-domain environment, you can return information for a given domain by including the -Domain parameter.

-------------------------- Example 3 --------------------------

Copy Code
Get-CsAdDomain -Report "C:\Domain_Report.html"

Example 3 retrieves the current status of your Active Directory domain and, at the same time, writes information about how that status was determined to a file named C:\Domain_Report.html. This file will detail the steps taken by Get-CsAdDomain to determine the readiness status for the domain; these steps include such tasks as verifying the existence of Active Directory groups, and checking permission settings on various Active Directory containers.