LCSCmd.exe Parameters and Switches

Microsoft Office Communications Server 2007 and Microsoft Office Communications Server 2007 R2 will reach end of support on January 9, 2018. To stay supported, you will need to upgrade. For more information, see Resources to help you upgrade your Office 2007 servers and clients.

Parameter Description

/Forest

Executes the action for the specified forest. If no fully qualified domain name (FQDN) is specified, the current forest is used.

/Domain

Executes the action for the specified domain. If no FQDN is specified, the current domain is used.

/Server

Executes the action for the specified computer. If no FQDN is specified, the current computer is used.

/Role

Specifies the role of the server.

/Archiving

Executes the action for the specified archiving computer. If no FQDN is specified, current computer is used.

/MCU

Executes the action for the specified MCU computer. If no FQDN is specified, current computer is used.

/Cert

Executes the selected certificate task on the current computer.

/Web

Executes the action for the specified WebComponents computer. If no FQDN is specified, current computer is used.

/Config

Exports or imports global, pool and/or computer-level configurations.

/Level

Specifies the levels of configurations that need to be exported or imported.

/Restore

Specifies the import of configuration data.

When used with computer level, the restore process imports WMI classes that contain settings that are specific to the local computer (for example, IP address, ports, and certificates). If the /Restore parameter is not explicitly specified, the import process does not import these classes. If you are exporting configuration from one computer to another, you cannot specify the restore parameter and then manually configure classes that contain computer specific settings. If you are exporting and importing on the settings on a same computer, you should specify the /Restore parameter so that all classes are restored.

When used with the global level, the /Restore parameter is used to import WMI classes that contain settings that are specific to the Active Directory topology (for example the location profile and A/V Authentication Service associated with each pool). The /Restore parameter should be used with the global level only when the Standard Edition Servers and Enterprise pools deployed in your topology have not changed since the configuration was exported. If the /Restore parameter is not specified these topology specific classes and properties must be configured.

When used with the pool level, this parameter is ignored.

/ConfigFile

Specifies the file to which to export or import configuration.

/Action

Takes a string specifying the action name. Valid action names include: SchemaPrep, CheckSchemaPrepState, CheckForestPrepState, ForestPrep, ForestUnprep, CheckAllDomainsPrepState, DomainPrep, CheckDomainPrepState, DomainUnPrep, CreateDelegation, CheckDelegation, RemoveDelegation, CreateLcsOuPermissions, CheckLcsOuPermissions, RemoveLcsOuPermissions, Activate/Deactivate, Diag, CheckLCServerState, CreatePool, RemovePool, CheckPoolState, CheckAllPoolsState, UpdatePoolBackend , Request, CheckStatus, ImportResponse, ImportPFX, ExportPFX, ListCA, ImportCAChain, and Export/Import.

/PoolName

Specifies the pool name.

/PoolBE

Specifies the backend Microsoft SQL Serverâ„¢ instance that will be used by the pool.

/RefDomain

Specifies the reference domain FQDN.

/DBDataPath

Specifies the folder where the database data file will be located.

/DBLogPath

Specifies the folder where the database log file is located.

/DynDataPath

Specifies the folder where the dynamic database data file should be located.

/DynLogPath

Specifies the folder where the dynamic database log file should be located.

/MeetingContentPath

Specifies the UNC path where meeting presentation content should be located.

/MeetingMetaPath

Specifies the UNC path where meeting Meta data should be located.

/PDCRequired

Specifies whether primary domain controllers are required for the action. For more information, see Optional LCSCmd.exe Parameters for Domain Controller and Global Catalog Server Discovery.

/DC

Specifies the FQDN of a domain controller. For more information, see Optional LCSCmd.exe Parameters for Domain Controller and Global Catalog Server Discovery.

/RootDC

Specifies the FQDN of a domain controller in the root domain. For more information, see Optional LCSCmd.exe Parameters for Domain Controller and Global Catalog Server Discovery.

/GC

Specifies the FQDN of a global catalog server. For more information, see Optional LCSCmd.exe Parameters for Domain Controller and Global Catalog Server Discovery.

/Global

Specifies the global setting location.

/User

Specifies the service account name for the server. If the specified user account does not exist, Office Communications Server 2007 automatically creates the account.

/GroupDomain

Specifies the FQDN of the domain where Office Communications Server universal groups are located.

/GroupDomainDC

Specifies the FQDN of a domain controller in the domain where Office Communications Server universal groups are located. For more information, see Optional LCSCmd.exe Parameters for Domain Controller and Global Catalog Server Discovery.

/UserUri1

Specifies the user URI (for example, alice@contoso.com). Required for logon and IM tests.

/UserAccount1

Specifies the sign-in name (for example, alice@contoso.com or contoso.com\alice). Required for logon and IM tests.

/UserPassword1

Specifies the user password. Required for logon and IM tests.

/UserPool1

Specifies the target server to use. If not specified, the pool of the local computer will be used.

/UserUri2

Specifies the user URI (for example, bob@contoso.com). Required for logon and IM tests.

/UserAccount2

Specifies the sign-in account (for example, bob@contoso.com or contoso.com\bob). Required for logon and IM tests.

/UserPassword2

Specifies the user password. Required for logon and IM tests.

/UserPool2

Specifies the target server to use. If not specified, the pool of the local computer will be used.

/FederatedUserUris

Specifies a list of federated user URIs to probe delimited by semicolon (for example, alice@contoso.com;bob@contoso.com).

/Clean

Specifies whether to do a clean setup for pool backend creation actions.

/EnableArch

Specifies whether archiving is enabled for the pool.

/EnableCDR

Specifies whether to enable CDR.

/PoolFQDN

Specifies DNS host name of the pool.

/InternalWebFQDN

Specifies the FQDN of the internal Web server.

/ExternalWebFQDN

Specifies the FQDN of the external Web server.

/ABOutputlocation

Specifies the folder where the Address Book server will write files.

/MeetingArchivingPath

Specifies the UNC path where meeting presentation content archiving should be located.

/Force

Specifies whether to force task execution.

/ldf

During schema preparation, specifies the LDF file directory.

/SipDomain

Specifies the default SIP domain FQDN.

/Type

Specifies the pool type.

/DBSetupFilePath

Specifies the folder where database setup files are located. (Folder paths and names must not end in a backslash (\) character.) If not specified, the "dbsetup" subdirectory is used.

/keepdb

Specifies whether to keep database data and transaction log files for the RemovePool action.

/logservers

A Boolean value that indicates whether to log servers in the pool.

/TrusteeGroup

Specifies the domain group to which you are granting permissions.

/TrusteeDomain

Specifies the FQDN of the domain in which the trustee group resides.

/OU

Specifies the distinguished name (DN) of the container excluding the domain root DN part.

/ObjectType

Specifies the type of objects on which to check, apply, or remove the Office Communications Server 2007 permissions.

/Delegation

Specifies the type of permissions granted to the trustee group.

/ApplyGlobalSettingsACE

Specifies whether to grant ACE on Global Settings container.

/ComputerOU

Specifies the DN of the organizational unit containing the computers running Office Communications Server servers. The organizational unit that is specified by the /ComputerOU parameter and the organizational unit that is specified by the /UserOU parameter must reside in the same domain.

If you want to delegate the administration of users in a domain other than the domain where Office Communications Server is installed, the organizational unit that is specified by the /ComputerOU parameter still must reside in the same domain as the organizational unit that is specified by the /UserOU parameter.

/UserOU

Specifies the DN of the organizational unit containing the users that the trustee group will administer. The organizational unit that is specified by the /ComputerOU parameter and the organizational unit that is specified by the /UserOU parameter must reside in the same domain.

/UserType

Specifies the type of the user object on which to create, check, or remove delegations.

/ServiceAccount

Specifies RTC service account name.

/ComponentServiceAccount

Specifies RTC component service account name.

/ExtraServers

Specifies a comma separated list of FQDNs of computers to which the trustee group requires access but are not part of the pool. You can enter the FQDN of Archiving and CDR Servers, Mediation Servers, or the internal FQDN of edge servers.

/DiagnosticLevel

Specifies a bitmask that selects the diagnostic sub-tasks to run. Valid values include:

  • 1 - check local server configuration

  • 2 - check connectivity

  • 4 - check SIP logon and instant messaging (IM)

  • 8 - check IM conferencing

  • 16 - check client auto-logon

You can combine these flags to run multiple sub-tasks. For example:

  • 31 - run all diagnostic tasks

/Components

Specifies a comma separated list of Edge Server components.

/online

Specifies whether online certificate operation is desired.

/friendlyName

Specifies the certificate's friendly name.

/bitlength

Specifies the public key length. Valid values are 1024, 2048, and 4096.

/exportable

Specifies whether the private key is exportable.

/org

Specifies the organization.

/sn

Specifies the subject name (SN) of the certificate, which is the FQDN of the local server or pool.

/san

Specifies a comma-separated list of names to be used in the Subject Alternate Name (SAN) of the certificate. The SN value of the certificate will be automatically added to the SAN if the SAN is non-empty unless the /autoAppendSNtoSAN parameter is specified with a value of FALSE.

/country

Specifies the country in the certificate details. This must be a two letter code. For example, US.

/state

Specifies the state in the certificate details. This must be a valid state or province and should not be an abbreviation.

/city

Specifies the city in the certificate details. This must be a valid city or locality and should not be an abbreviation.

/filename

Specifies the file name for storing an offline certificate request. This must be a nonexistent file.

/ca

Specifies the certification authority (CA) to use for online certificate requests. This is a required parameter for online certificate requests. It should be of the form CAFQDN\CAName.

/caAccount

If integrated authentication is not desired, then supplies an account that is recognized by the CA and has privileges to request certificates. This parameter is ignored if CredMan is not available.

/caPassword

Specifies the password to be used with /caAccount. This parameter is ignored if /caAccount is not specified.

/autoAppendSNToSAN

Specifies whether the Subject Name should be appended to the Subject Alternate Name list if the list is non-empty.

/enableClientEKU

Specifies whether the certificate should contain the Client Authentication EKU (usually not required except for some types of federation).

/requestID

Specifies the pending certificate request identifier.

/Issuer

Specifies the certificate issuer. Specify the common name only.

/subjectName

Specifies the subject name.

/serialNumber

Specifies the certificate serial number.

/includeChain

Specifies whether to include the certificate chain in the certificate.

/Authentication

Specifies the authentication protocols to be used for the server specified. Valid values include:

  • 0 - no authentication

  • 1 - NTLM authentication

  • 2 - Kerberos authentication

/TransportType

Specifies the type of transport protocol to be used to connect to the server. Valid values include:

  • 0 - none

  • 1 - TCP

  • 2 - TLS

/SignalingOnly

Boolean value that specifies whether the endpoint publishes presence. Valid values include:

TRUE - the endpoint does not publish presence but uses only signaling.

FALSE- the endpoint will publish presence.

/Port

Specifies the port to be used to connect to the server.

/AllowNoAuthentication

Specifies whether the client allows communicating with a server that does not challenge messages from this client.

/User1

Specifies the account of the first conference user.

/User2

Specifies the account of the second conference user.

/Password1

Specifies the password of the first conference user.

/Password2

Specifies the password of the second conference user.

/AdmissionPolicy

Specifies conference admission policy. Valid values include:

  • 0 - None

  • 1 - ClosedAuthenticated

  • 2 - OpenAuthenticated

  • 3 - Anonymous

/Presenters

Specifies a comma-separated list of presenter domain accounts.

/Attendees

Specifies a comma-separated list of attendee domain accounts.

/MCUs

Specifies a comma-separated list of conferencing servers. Valid values include:

  • audio-video

  • chat

  • meeting

  • phone-conf

/ID

Specifies conference ID.

/URI

Specifies conference user resource identifier (URI).

/Message

Specifies test message.

/TargetServer

Specifies a server to check connectivity.

/TlsTarget

Specifies TLS target FQDN (if it is different from /TargetServer).

/TargetURI

Specifies a URI to check connectivity. This parameter is used only when HTTP or HTTPS transport type is selected. This parameter is required for HTTP and HTTPS transport types.

/L

Specifies the log file path. If not specified, %TEMP%\<ActionName>[<Date>][<Time>].html is used. To disable logging, use a dash character (-) as the log file name.

/XML

Specifies whether the log file to be generated should be in XML format instead of HTML.

/?

Shows Help on usage. You can specify the help parameter at any level to provide more context on the available usage.