Use the Configuration Manager 2012 CCMSetup.exe command to manually install the Configuration Manager 2012 client software on computers in your enterprise.
CCMSetup downloads all the necessary files to complete the client installation from a specified management point or from a specified source location. These files might include the following:
- The executable client.msi that installs the
Configuration Manager 2012 client software.
- Background Intelligent Transfer Service
(BITS) installation files (if required).
- Windows Installer installation files (if
required).
- Patches and fixes for the
Configuration Manager 2012 client (if required).
Note |
---|
In Configuration Manager 2012, you cannot run client.msi directly. |
CCMSetup.exe provides several command-line properties to customize the installation behavior. Additionally, you can also specify properties to modify the behavior of client.msi in the CCMSetup.exe command line.
Important |
---|
You must specify all required CCMSetup properties before you specify properties for client.msi. |
CCMSetup.exe and its supporting files are located on the Configuration Manager 2012 site server in the Client folder of the Configuration Manager 2012 installation folder. This folder is shared to the network as <Site Server Name>\SMS_<Site Code>\Client.
The format of the CCMSetup.exe command line is as follows:
CCMSetup.exe [Ccmsetup properties] [client.msi setup properties]
For example, CCMSetup.exe /mp:SMSMP01 /logon SMSSITECODE=S01 FSP=SMSFSP01 performs the following actions:
- Specifies to download installation files from
the management point named SMSMP01.
- Specifies that installation should stop if a
version of the Configuration Manager 2012 or SMS 2003
client already exists on the computer.
- Instructs client.msi to assign the client to
the site code S01.
- Instructs client.msi to use the fallback
status point named SMSFP01.
Note |
---|
If a property contains spaces, surround it by quotation marks (""). |
The properties described in the following table are available to modify the installation behavior of CCMSetup.exe.
Important |
---|
If you have extended the Active Directory schema for Configuration Manager 2012, many client installation properties are published in Active directory and read automatically by the Configuration Manager 2012 client. For a list of the client installation properties published in Active Directory, see About Client Installation Properties Published to Active Directory Domain Services in Configuration Manager 2012. |
CCMSetup.exe Command-Line Properties
Property | More Information | ||||
---|---|---|---|---|---|
/? |
Opens the CCMSetup dialog box showing command-line properties for ccmsetup.exe. Example: CCMSetup.exe /? |
||||
/source:<Path> |
Specifies the location from which to download installation files. You can use a local or UNC installation path. Files are downloaded by using the server message block (SMB) protocol.
Example: CCMSetup.exe /source:"\\computer\folder" |
||||
/mp:<Computer> |
Specifies the source management point for downloading installation files. Files are downloaded over an HTTP or HTTPS connection, depending on the management configuration for client connections. This download uses BITS throttling, if BITS throttling is configured. If the management point is configured for HTTPS client connections only, you must verify that the client computer has a valid PKI client certificate.
Example: CCMSetup.exe /mp:SMSMP01 |
||||
/retry:<Minutes> |
Specifies the retry interval if CCMSetup.exe fails to download installation files. The default value is 10 minutes. CCMSetup continues to retry until it reaches the limit specified in the downloadtimeout installation property. Example: CCMSetup.exe /retry:20 |
||||
/noservice |
Prevents CCMSetup from running as a service which might have insufficient rights to access network resources. If this property is not specified, /service will be used by default. Example: CCMSetup.exe /noservice |
||||
/service |
Specifies that CCMSetup should run as a service using the local system account. Example: CCMSetup.exe /service |
||||
/uninstall |
Specifies that the Configuration Manager 2012 client software should be uninstalled. For more information, see How to Manage Clients in Configuration Manager 2012. Example: CCMSetup.exe /uninstall |
||||
/logon |
Specifies that the client installation should stop if any version of the Configuration Manager 2012 or SMS client is already installed. Example: CCMSetup.exe /logon |
||||
/forcereboot |
Specifies that CCMSetup should force the client computer to restart if this is necessary to complete the client installation. If this option is not specified, CCMSetup exits when a restart is necessary and then continues after the next manual restart. Example: CCMSetup.exe /forcereboot |
||||
/BITSPriority:<Priority> |
Specifies the download priority when client installation files are downloaded over an HTTP connection. Possible values are as follows:
The default value is NORMAL. Example: CCMSetup.exe /BITSPriority:HIGH |
||||
/downloadtimeout:<Minutes> |
Specifies the length of time in minutes that CCMSetup attempts to download the client installation files before it gives up. The default value is 1440 minutes (1 day). Example: CCMSetup.exe /downloadtimeout:100 |
||||
/UsePKICert |
When specified, the client will use a PKI certificate that includes client authentication, if one is available. If a valid certificate cannot be found, the client falls back to using an HTTP connection and a self-signed certificate. When this option is not specified, the client uses a self-signed certificate and all communications to site systems are over HTTP.
Example: CCMSetup.exe /UsePKICert CCMSetup.exe |
||||
/NoCRLCheck |
Specifies that a client should not check the certificate revocation list (CRL) when it communicates over HTTPS by using a PKI certificate. When this option is not specified, the client will check the CRL before establishing an HTTPS connection by using PKI certificates. Example: CCMSetup.exe /UsePKICert /NoCRLCheck |
||||
/config:<configuration file> |
Specifies the name of a text file containing client installation properties. Unless you also specify the /noservice CCMSetup property, this file must be located in the CCMSetup folder, which is <%Windir%>\System32\ccmsetup for 32-bit operating systems and <%Windir%>\ccmsetup for 64-bit operating system. If you specify the /noservice property, this file must be located in the same folder from which you run CCMSetup.exe. Example: CCMSetup.exe /config:<Configuration File Name.txt> Use the mobileclienttemplate.tcf file in the <Configuration Manager directory>\bin\<platform> folder on the site server computer to provide the correct format of the file. This file also contains information in comment form about the sections and how they are used. Specify the client installation properties in the [Client Install] section, after the following text: Install=INSTALL=ALL. Example [Client Install] section entry: Install=INSTALL=ALL SMSSITECODE=ABC SMSSLP03 SMSCACHESIZE=100 |
Client.msi Properties
The properties described in the following table can modify the installation behavior of client.msi. If you use the client push installation method, you can also specify the properties in the Client tab of the Client Push Installation Properties dialog box.
Property | More Information | ||||
---|---|---|---|---|---|
CCMALWAYSINF |
Set to 1 to specify that the client will always be Internet-based and will never connect to the intranet. The client's connection type will display Always Internet. This property should be used in conjunction with CCMHOSTNAME, which specifies the FQDN of the Internet-based management point. It should also be used in conjunction with the CCMSetup property /UsePKICert and with the site code. For more information about Internet-based client management, see Overview of Internet-Based Client Management. Example: CCMSetup.exe /UsePKICert CCMALWAYSINF=1 CCMHOSTNAME=SERVER3.CONTOSO.COM SMSSITECODE=ABC |
||||
CCMCERTSEL |
Specifies the certificate selection criteria if the client has more than one certificate that can be used for HTTPS communication (a valid certificate that includes client authentication capability). You can search for an exact match in the Subject Name or Subject Alternative Name (use Subject:) or a partial match (use SubjectStr:), in the Subject Name or Subject Alternative Name. Examples: CCMCERTSEL="Subject:computer1.contoso.com" searches for a certificate with an exact match to the computer name "computer1.contoso.com" in either the Subject Name, or the Subject Alternative Name. CCMCERTSEL="SubjectStr:contoso.com" searches for a certificate that contains "contoso.com" in either the Subject Name, or the Subject Alternative Name. You can also use Object Identifier (OID) or distinguished name attributes in the Subject Name or Subject Alternative Name attributes, for example: CCMCERTSEL="SubjectAttr:2.5.4.11 = Computers" searches for the organizational unit attribute expressed as an object identifier, and named Computers. CCMCERTSEL="SubjectAttr:OU = Computers" searches for the organizational unit attribute expressed as a distinguished name, and named Computers.
The complete list of attributes that you can use for certificate selection is listed in Supported Attribute Values for the PKI Certificate Selection Criteria. If more than one certificate matches the search, and the property CCMFIRSTCERT has been set to 1, the certificate with the longest validity period is selected. |
||||
CCMCERTSTORE |
Specifies an alternate certificate store name if the client certificate to be used for HTTPS communication is not located in the default certificate store of Personal in the Computer store. Example: CCMSetup.exe /UsePKICert CCMCERTSTORE="ConfigMgr" |
||||
CCMFIRSTCERT |
If set to 1, this property specifies that the client should select the PKI certificate with the longest validity period. This setting might be required if you are using Network Access Protection with IPsec enforcement. Example: CCMSetup.exe /UsePKICert CCMFIRSTCERT=1 |
||||
CCMHOSTNAME |
Specifies the FQDN of the Internet-based management point, if the client is managed over the Internet. Do not specify this option with the installation property of SMSSITECODE=AUTO. Internet-based clients must be directly assigned to their Internet-based site. Example: CCMSetup.exe /UsePKICert/ CCMHOSTNAME="SMSMP01.corp.contoso.com" |
||||
CCMHTTPPORT |
Specifies the port that the client should use when communicating over HTTP to site system servers. If the port is not specified, the default value of 80 will be used. Example: CCMSetup.exe CCMHTTPPORT=80 |
||||
CCMHTTPSPORT |
Specifies the port that the client should use when communicating over HTTPS to site system servers. If the port is not specified, the default value of 443 will be used. Example: CCMSetup.exe /UsePKICert CCMHTTPSPORT=443 |
||||
SMSPUBLICROOTKEY |
Specifies the Configuration Manager trusted root key where it cannot be retrieved from Active Directory Domain Services. This property applies to clients that use HTTP and HTTPS client communication. For more information, see How to Pre-Provision the Trusted Root Key on Clients. Example: CCMSetup.exe SMSPUBLICROOTKEY=<key> |
||||
SMSROOTKEYPATH |
Used to reinstall the Configuration Manager trusted root key. Specifies the full path and file name to a file containing the trusted root key. This property applies to clients that use HTTP and HTTPS client communication. For more information, see How to Pre-Provision the Trusted Root Key on Clients. Example: CCMSetup.exe SMSROOTKEYPATH=<Full path and filename> |
||||
RESETKEYINFORMATION |
If a Configuration Manager 2012 client has the wrong Configuration Manager trusted root key and cannot contact a trusted management point to receive a valid copy of the new trusted root key, you must manually remove the old trusted root key by using this property. This situation commonly occurs when you move a client from one site hierarchy to another. This property applies to clients that use HTTP and HTTPS client communication. Example: CCMSetup.exe RESETKEYINFORMATION=TRUE |
||||
CCMDEBUGLOGGING |
Enables debug logging. Values can be set to 0 (off) or 1 (on). The default value is 0. This causes the client to log low-level information that might be useful for troubleshooting problems. As a best practice, avoid using this property in production sites because excessive logging can occur, which might make it difficult to find relevant information in the log files. CCMENABLELOGGING must be set to TRUE to enable debug logging. Example: CCMSetup.exe CCMDEBUGLOGGING=1 |
||||
CCMENABLELOGGING |
Enables logging if this property is set to TRUE. By default, logging is enabled. The log files are stored in the Logs folder in the Configuration Manager Client installation folder. By default, this folder is %Windir%\System32\CCM\Logs. Example: CCMSetup.exe CCMENABLELOGGING=TRUE |
||||
CCMLOGLEVEL |
Specifies the amount of detail to write to Configuration Manager 2012 log files. Specify an integer ranging from 0 to 3, where 0 is the most verbose logging and 3 logs only errors. The default is 1. Example: CCMSetup.exe CCMLOGLEVEL=3 |
||||
CCMLOGMAXHISTORY |
When a Configuration Manager 2012 log file reaches 250000 bytes in size (or the value specified by the property CCMMAXLOGSIZE), it is renamed as a backup, and a new log file is created. This property specifies how many previous versions of the log file to retain. The default value is 1. If the value is set to 0, no old log files are kept. Example: CCMSetup.exe CCMLOGMAXHISTORY=0 |
||||
CCMLOGMAXSIZE |
Specifies the maximum log file size in bytes. When a log grows to the size that is specified, it is renamed as a history file, and a new file is created. This property must be set to at least 10000 bytes. The default value is 250000 bytes. Example: CCMSetup.exe CCMLOGMAXSIZE=300000 |
||||
CCMALLOWSILENTREBOOT |
Specifies that the computer will be allowed to restart following the client installation, if this is required.
Example: CCMSetup.exe CCMALLOWSILENTREBOOT |
||||
DISABLESITEOPT |
If set to TRUE, disables the ability of end users with administrative credentials on the client computer to change the Configuration Manager Client assigned site by using Configuration Manager in Control Panel of the client computer. Example: CCMSetup.exe DISABLESITEOPT=TRUE |
||||
DISABLECACHEOPT |
If set to TRUE, disables the ability of end users with administrative credentials on the client computer to change the temporary program download folder settings for the Configuration Manager Client by using Configuration Manager in Control Panel of the client computer. Example: CCMSetup.exe DISABLECACHEOPT=TRUE |
||||
SMSCACHEDIR |
Specifies the location of the cache folder on the client computer, which stores temporary files. By default, the location is %Windir%\System32\CCM\Cache. Example: CCMSetup.exe SMSCACHEDIR="C:\Temp" This property can be used in conjunction with the SMSCACHEFLAGS property to further control the client cache folder location. Example: CCMSetup.exe SMSCACHEDIR=Cache SMSCACHEFLAGS=MAXDRIVE installs the client cache folder on the largest available disk drive on the client. |
||||
SMSCACHEFLAGS |
Configures the Configuration Manager 2012 cache folder, which stores temporary files. You can use SMSCACHEFLAGS properties individually or in combination, separated by semicolons. If this property is not specified, the client cache folder is installed according to the SMSCACHEDIR property, the folder is not compressed, and the SMSCACHESIZE value is used as the size in MB of the folder. Specifies further installation details for the client cache folder. The following properties can be specified:
If this property is not specified, the client cache folder will be created according to the SMSCACHEDIR property, will not be compressed and will be the size specified in the SMSCACHESIZE property. Example: CCMSetup.exe SMSCACHEFLAGS=NTFSONLY;COMPRESS
|
||||
SMSCACHESIZE |
Specifies the size of the client cache folder in MB or as a percentage when used with the PERCENTDISKSPACE or PERCENTFREEDISKSPACE property. If this property is not set, the folder defaults to a maximum size of 5120 MB.
This setting is ignored when upgrading an existing client. Example: CCMSetup.exe SMSCACHESIZE=100 |
||||
SMSCONFIGSOURCE |
Specifies the location and order that the Configuration Manager Client Installer checks for configuration settings. The property is a string containing one or more characters, each defining a specific configuration source. Use the character values R, P, M, and U, alone or in combination, as shown in the following examples:
By default, the client installation uses PU to check first the installation properties and then the existing settings. Example: CCMSetup.exe SMSCONFIGSOURCE=RP |
||||
SMSDIRECTORYLOOKUP |
Specifies how the client uses Windows Internet Name Service (WINS) for service location. Service location by using WINS and HTTP client communication includes the management point and server locator point. Service location by using WINS and HTTPS client communication includes the server locator point only. If WINS is not used by clients to find a server locator point, it must be directly assigned to clients, for example, by using the SMSSLP Client.msi property. This property has no impact on whether the client uses WINS for name resolution.. You can configure how WINS is used for service location using one of the following three modes:
If this property is not specified, the default value of WINSSECURE will be used. Example: CCMSetup.exe SMSDIRECTORYLOOKUP=NOWINS |
||||
SMSSIGNCERT |
Specifies the full path and .cer file name of the exported self-signed certificate on the site server. This certificate is stored in the SMS certificate store and has the Subject name Site Server and the friendly name Site Server Signing Certificate. Example: CCMSetup.exe /UsePKICert SMSSIGNCERT=<Full path and file name> |
||||
SMSMP |
Associates the Configuration Manager 2012 client with the specified management point. You can specify a fully qualified domain name as this property. Example: CCMSetup.exe SMSMP=SMSMP01 |
||||
SMSSITECODE |
Specifies the Configuration Manager 2012 site to assign the Configuration Manager Client to. This can either be a three-character Configuration Manager 2012 site code or the word AUTO. If AUTO is specified, the Configuration Manager Client attempts to determine its Configuration Manager 2012 site assignment by using Active Directory or a server locator point.
Example: CCMSetup.exe SMSSITECODE=AUTO |
||||
SMSSLP |
Specifies the server locator point for site assignment and locating management points for clients that cannot locate this information from Active Directory Domain Services, DNS, or WINS. Example: CCMSetup.exe SMSSLP=SMSSLP01 |
||||
CCMINSTALLDIR |
Identifies the folder where the Configuration Manager Client files are installed. If this property is not set, then the client software is installed in the %Windir%\System32\CCM folder. Regardless of where the Configuration Manager Client files are installed, the Ccmcore.dll file is always installed in the %Windir%\System32 folder. Example: CCMSetup.exe CCMINSTALLDIR="C:\Temp" |
||||
CCMADMINS |
Specifies one or more Windows user accounts or groups to be given access to client settings and policies. This is useful where the Configuration Manager 2012 administrator does not have local administrative credentials on the client computer. You can specify a list of accounts separated by semi-colons. Example: CCMSetup.exe CCMADMINS="Domain\Account1;Domain\Group1" |
||||
FSP |
Specifies the fallback status point that receives and processes state messages sent by Configuration Manager 2012 client computers. For more information about the fallback status point, see About the Fallback Status Point in Configuration Manager 2012. Example: CCMSetup.exe FSP=SMSFP01 |
||||
DNSSUFFIX |
Specifies the DNS domain to use for locating the default management point in DNS, when DNS publishing is used. For more information about locating management points in DNS, see Configuration Manager and Service Location. If this property is specified, SMSSITECODE must not be set to AUTO. When this property is specified, client assignment looks for a DNS service location resource record (SRV RR) in DNS, which includes this DNS suffix of the management point. For the exact record format, see How to Manually Publish the Default Management Point to DNS.
Example: CCMSetup.exe SMSSITECODE=ABC DNSSUFFIX=contoso.com |
Supported Attribute Values for the PKI Certificate Selection Criteria
Configuration Manager 2012 supports the following attribute values for the PKI certificate selection criteria:
OID Attribute | Distinguished Name Attribute | Attribute Definition |
---|---|---|
0.9.2342.19200300.100.1.25 |
DC |
Domain component |
1.2.840.113549.1.9.1 |
E or E-mail |
E-mail address |
2.5.4.3 |
CN |
Common name |
2.5.4.4 |
SN |
Subject name |
2.5.4.5 |
SERIALNUMBER |
Serial number |
2.5.4.6 |
C |
Country code |
2.5.4.7 |
L |
Locality |
2.5.4.8 |
S or ST |
State or province name |
2.5.4.9 |
STREET |
Street address |
2.5.4.10 |
O |
Organization name |
2.5.4.11 |
OU |
Organizational unit |
2.5.4.12 |
T or Title |
Title |
2.5.4.42 |
G or GN or GivenName |
Given name |
2.5.4.43 |
I or Initials |
Initials |
2.5.29.17 |
(no value) |
Subject Alternative Name |