Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Get-CsAdDomain

 

Topic Last Modified: 2013-02-20

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

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

Example 1 returns information regarding the current status of your local Active Directory domain. If your domain settings are up-to-date, and the domain is ready to host Lync Server, the value LC_DOMAIN_SETTINGS_STATE_READY will be returned.

Get-CsAdDomain

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

Get-CsAdDomain -Domain "fabrikam.com" 

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

Get-CsAdDomain -Report "C:\Logs\DomainReport.html"

Before you can install Lync Server your domain must be correctly prepared, a process that includes extending the Active Directory schema to allow for the addition of attributes specific to Lync Server, in addition to assigning the required Access Control Entries to the universal groups used for managing and operating Lync Server. The Get-CsAdDomain cmdlet returns a single value that tells you whether or not Lync Server can be installed on a domain. If the Get-CsAdDomain cmdlet returns the value LC_DOMAINSETTINGS_STATE_READY then you can install Lync 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 Lync Server.

The Get-CsAdDomain cmdlet runs as part of the Setup Wizard. If the Wizard determines that the domain is not correctly prepared, an error message is displayed and setup will stop. However, you can run the Get-CsAdDomain cmdlet independently of the Setup Wizard in order to verify the domain status before you try to install Lync Server.

Thhhe Get-CsAdDomain cmdlet performs the same function as the following Microsoft Office Communications Server 2007 R2 command:

Lcscmd.exe /domain /action:CheckDomainPrepState

Who can run this cmdlet: By default, any user who has read permissions to Active Directory can run the Get-CsAdDomain cmdlet. Typically all domain members have this permission.

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

 

Parameter Required Type Description

Domain

Optional

Microsoft.Rtc.Management.Deploy.Fqdn

Fully qualified domain name (FQDN) 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

Microsoft.Rtc.Management.Deploy.Fqdn

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

GlobalCatalog

Optional

Microsoft.Rtc.Management.Deploy.Fqdn

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

GlobalSettingsDomainController

Optional

Microsoft.Rtc.Management.Deploy.Fqdn

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

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\DomainPrep.html"

None. The Get-CsAdDomain cmdlet does not accept pipelined input.

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

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.