CMU - CodeMeter Universal Support Tool

You have also the option to alternatively execute some CodeMeter Control Center functions by the commandline based CodeMeter Universal Support Tool (cmu).

cmu supports you in:

listing of CmContainer contents

creating a simple test environment for CmContainer

executing a certified time update, and creating and import of license request and update files (Remote Context and Update files, *.WibuRaC; *.WibuRaU)

Call cmu in the directory %\Program Files%\CodeMeter\Runtime\bin using the command cmu[32].exe.

WIN

Alternatively, on Windows call cmu by the start menu item "Start | All Programs | CodeMeter | Tools | CodeMeter Command Prompt".

win8_logo

Press "Windows" key to open Start screen | Type "CodeMeter Command Prompt" | Press "Enter" key.

For the operating systems MacOS macOS and LINUX Linux this command is provided by the usual search path parameter.

information_weiss_klein26

cmu on Linux operating systems uses the libusb program library to read and write USB devices. The code is licensed under the GNU Lesser General Public License (LGPL) Version 3. The code of the programming library libusb can be downloaded at the project website http://www.libusb.org/. On request, the source can also be electronically obtained free of charge contacting Wibu-Systems (support@wibu.com).

The following list shows all existing cmu commands.

Command

Description

/h or --help

shows this help in the commandline window.

/v or --version

shows the versions of all available CodeMeter® components.

/l or--list

lists all connected CmContainer by way of their serial numbers.

/x or --list-content

lists the contents of all connected CmContainer.

/k or --list-server

lists all available network license server.

/n or –-list-network

list the complete network license information.

--add-server

adds a server to the end of your server search list. As an argument pass the server's name, IP or CmWAN URL.

Examples:

server.domain.local

192.168.0.72

fe80::ea06:88ff:fecf:df6f

https://user:secretpassword@server.domain.local/cmwan

--delete-server

deletes a server from the server search list. As an argument pass the server's name, IP or CmWan URL as it is listed.

-- clear-serversearchlist

deletes all the entries from the server search list.

--show-serversearchlist

shows the entries in the server search list.

/c <FI> or --context <FI>

creates a license request for an license update via CmFAS creates a license request for an license update via Firm Item <FI>.

Using option --file specifies the output file. If no option is set the standard output is used (stdout).

/i or --import

imports a license update file received via CmFAS for the available CodeMeter® license.

Using option --file specifies the file name. The update can cover a CmDongle or a CmActLicense license file.

/d or --firmware-update

starts the firmware update of a CmContainer.

/u or --time-update

starts the update of the Certified Time in each connected CmContainer.

/e <s> or --enable <s>

allows the activation or deactivation of the selected CmContainer. Specifying the CodeMeter® password is required.

The required new Enabling status is specified by the parameter <s>. Parameter values cover 1 (disable), 2 (temporary enable), 3 (enable).

/t <no> or --test<no>

starts some simple tests for each connected CmContainer. The number of tests is specified by parameter <no>.

It is required that the CmContainer must be (temporarily) enabled.

/vv or --cmdust

creates a CmDust report. This report is useful and required when requesting support. Wibu-Systems recommends to create a CmDust report before contacting the support.

Using the option --file writes the result into a text file.

--borrow

allows the borrowing of licenses from a license server to the local PC. You have to specify the Firm Code and the Product Code of the license using the options --firmcode and --productcode. As an additional option you may specify the Feature Map using the option --featuremap. Moreover, you have to specify the serial number of the client CmContainer and the server name using the options --serial and --server.

--return

returns the borrowed license to the license server. You have to specify the Firm Code and the Product Code of the license using the options --firmcode and --productcode and the serial number of the client CmContainer and the server name using the options --serial and --server.

--borrowlist

lists the borrowed licenses for the client and the server.

--transferlist

creates a listing of the license transfer relevant data.

--enabling

lists the enabling stati of all connected CmContainer.

Combined with the command –x you can also display additional enabling information of the CmContainer content.

--create-io

is used in combination with the option --file and makes sense only when using the hardware form factors CmCard/SD or CmCard/CF. A new codemtr.io file is created.

Please call this command only if the codemtr.io file is deleted.

--detect-proxy

detects the proxy settings of the system. When options are omitted the standard output is used (stdout). The option --write saves the settings using the CodeMeter® profiling.

--delete-cmact-license

deletes a CmActLicense license you specify using the command --serial.

information_grau_klein26

Once you delete a CmActLicense license it cannot be restored.

--set-access-data

sets WebAdmin user authentication. Use with options --user and --password to define username and password.

--reset-access-data

resets WebAdmin user authentication. "Local Access only" will be set.

--device-id

sets this parameter on import of WibuCmLiF files (--import) with binding scheme "Binding Extension".

The input of the device-id is as 128 hex digits preceeded by "0x".

License transfer options

All calls existing in CodeMeter Core API for the licenses transfer feature can also be called using cmu. Here the respective files are used  (WibuCmLIF/WibuCmRaC/WibuCmRaU). The following cmu calls exist:

Command

Description

--create-lt-context <parameters>

Enables to create a license transfer context.

Used with --lt-push  parameters to specify the nature of the transfer - license update with FSB if omitted.

Additional parameters:

--lt-request-file <file>

is a mandatory parameter.

It is used to specify the file <file> where the result of the license context creation should be written.

--lt-context-file <file>

It is used to specify the file <file> containing the license context to be created.

--serial <serial> or -s <serial>

selects the CmContainer with the specified Serial Number.

--firmcode <fc>

sets the Firm Code of the transferred license.

--productcode <pc>

sets the Product Code of the transferred license.

--create-lt-update <parameters>

Enables to transfer a license transfer context. Used with one of following parameters to specify the nature of the transfer:

--lt-move-licenses <licenses>

the specified number of licenses wil be transferred.

--lt-borrow-local-license <expiration time>

expiration time as <YYYY>-<MM>-<DD>[T<hh>:<mm>:<ss>] (one license will be transferred for the specified time limit).

--lt-renewborrow <expiration time>

time validity of an already borrowed license will be extended.

Additional mandatory parameters:

--lt-request-file <file>

is a mandatory parameter.

It is used to specify the file <file> containing the license context to be transferred.

--lt-update-file <file>

is a mandatory parameter.

It is used to specify the file <file> where the result of the license transfer should be written.

--serial <serial> or -s <serial>

selects the CmContainer with the specified Serial Number.

--firmcode <fc>

sets the Firm Code of the transferred license.

--productcode <pc>

sets the Product Code of the transferred license.

Additional optional parameters:

--lt-feature-code <number>

It is used to specify the Feature Code <number>. The default input for the <number> is in decimal unless it begins with 0x or 0X.

--lt-product-ref <number>

It is used to specify the Product Item Reference <number>. The default input for the <number> is in decimal unless it begins with 0x or 0X.

--import-lt-update <parameters>

Updates license transfer data on the target side. Used with either --lt-push, --lt-pull, --lt-fsb or --lt-return parameters to specify the nature of the transfer.

Additional parameters:

--lt-update-file <file>

is a mandatory parameter.

It is used to specify the file <file> where the result of the license update should be written.

--serial <serial> or -s <serial>

optionally selects the CmContainer with the specified Serial Number.

--firmcode <fc>

optionally sets the Firm Code of the transferred license.

--productcode <pc>

sets the Product Code of the transferred license (optional, only with --firmcode).

--create-lt-receipt <parameters>

Creates a signature with a defined private key and gives it back as a receipt to specify the nature the transfer.

Additional parameters:

--lt-receipt-file <file>

is a mandatory parameter.

It is used to specify the file <file> where the receipt will be transferred to.

--serial <serial> or -s <serial>

selects the CmContainer with the specified Serial Number.

--firmcode <fc>

sets the Firm Code of the transferred license.

--productcode <pc>

sets the Product Code of the transferred license.

--import-lt-receipt <parameters>

Checks the receipt with a defined public key confirming the validity of a transaction. Used with one of following parameters to specify the nature of the transfer.

Additional parameters:

--lt-receipt-file <file>

is a mandatory parameter.

It is used to specify the file <file> where the data will be transferred from.

--serial <serial> or -s <serial>

selects the CmContainer with the specified Serial Number.

--firmcode <fc>

sets the Firm Code of the transferred license.

--productcode <pc>

sets the Product Code of the transferred license.

--lt-cleanup <parameters>

Possible cleanup action

 

--deleted

clean deleted licenses

--disabled

clean disabled (dangerous)

--hiddenhistory

clean history of given product item

--container

removes whole license container (dangerous)

Additional parameter

--serial <serial> or -s <serial>

selects the CmContainer with the specified Serial Number.

--firmcode <fc>

selects the Firm Code of the transferred license.

--productcode <pc>

selects the Product Code of the transferred license.

--lt-product-ref <number>

It is used to specify the Product Item Reference <number>. The default input for the <number> is in decimal unless it begins with 0x or 0X.

 

Named User licenses

The values of the username and the domain are automatically set.

Options

Description

--nmu-userdefined <text>

Specifies via <text> a case-sensitive UTF-8 string for the user-defined text. The string is truncated after 127 bytes.

Additional cmu options

The following list shows additional cmu options:

Options

Description

/f <file> or --file <file>

Additional option which writes the command result into a file <file>. This option is used in combination with the commands --context, --import, --cmdust.

/s <serial> or --serial <serial>

Additional option which defines that a command is valid only for a CmContainer specified by its serial number <serial>, e.g. "1-10234242".

/p <pwd> or --password <pwd>

Additional option in combination with the commands --enable and --firmware-update. This option defines the required CodeMeter Password for this command.

--firmcode <fc>

Additional option in combination with the commands --borrow or --return specifying the Firm Code of the borrowed license.

--productcode <pc>

Additional option in combination with the commands --borrow or --return specifying the Product Code of the borrowed license.

--featuremap <fm>

Additional option in combination with the commands --borrow or --return specifying the Feature Map of the borrowed license.

--server <servername>

Additional option to borrow a license from another server. Is used in combination with command --borrow.

--write

Additional option used in combination with the command --detect-proxy which saves the setting using the CodeMeter® profiling. These settings are written only if no proxy has been previously set in the profiling. For overwriting the settings use the option --force.

--force

Additional option used in combination with the command --detect-proxy which overwrites already existing proxy settings in the CodeMeter®profiling.

--show-config-disk

Shows the current settings of removable/fixed drives or of the type of the defined Master Boot Record (MBR).

This option concerns the behavior of virtual flash memory partitions. Use only for CmStick and CmStick/M.

--set-config-disk <parameter>

Allows to define a special behavior of virtual flash memory partitions, e.g. drive settings, boot code or activations (CmDongle only).

information_grau_klein26

Please note that replugging of the CmDongle is required.

Description

Parameter

Drive settings

RemovableDisk,LocalDisk

Boot Code

Int18Boot,ZeroBoot,LoopBoot,SwapBoot,VbrBoot

Activation

ActivePartition,InactivePartition

FAT

Fat16,Fat32

USB-Communication Device Class

HidCommunication; MsdCommunication

--check-cm-integrity

Allows to check the CodeMeter® signature.

--licensing-terms

Print licensing terms of GNU Lesser General Public License (LGPL) 3.0.

Application examples

Action

Parameter

Displaying cmu options

Cmu[32].exe -h

Creating a CodeMeter® Remote Activation Context file (here:1-1040870.WibuCmRaC) for the Firm Code 10 (Firm Item level)

Cmu[32].exe -c10 -f1-140870.WibuCmRaC

Importing a CodeMeter® Remote Activation Update file (here:1-1040870.WibuCmRaU) --> reprograms the connected CmContainer

Cmu[32].exe -i -f1-1040870.WibuCmRaU

Showing the versions of current CodeMeter® components.

cmu32 --version

Listing all available CodeMeter network license server and if existing all related licenses.

cmu32 --list-server --list-content

Starting 100 simple tests. The tests are executed only for the CmContainer specified by the serial number of 1-233232.

cmu32 --test 100 --serial 1-233232

Changing the enabling status to "temporarily enabled" for the CmContainer 1-2345 by using the CodeMeter® password "SECRET".

cmu32 --enable2 --serial 1-2345 --password SECRET