License Admin
License Admin
License Admin
R2024a
How to Contact MathWorks
Phone: 508-647-7000
Licensing Overview
1
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
v
Use Timeouts for Idle License Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
vi Contents
1
Licensing Overview
Audience
This guide contains instructions for performing tasks concerning the installation and licensing of
MathWorks® products. For some procedures, you must be an administrator on the license. To learn if
you are an administrator on a license, go to License Center on the MathWorks website.
See Also
Related Examples
• “Master Licenses” on page 1-3
• “Administering Individual Licenses”
• “Administering Designated Computer Licenses”
• “Administering Network Named User Licenses”
• “Borrow Licenses” on page 7-2
1-2
Master Licenses
Master Licenses
What Is a Master License?
In MathWorks software licensing, all your licenses fall under a single Master License. A Master
License enables you to organize MathWorks licenses for easy administration and renewal. A Master
License has these characteristics:
• Can have one or multiple licenses, each of which can have different license options.
• Can have one administrator or multiple administrators, each of whom can centrally manage all
licenses within a Master License.
• A Master License provides a single Software Maintenance Service renewal for all licenses within
the Master License. If you want to receive a single renewal quote, put all your licenses in one
Master License.
• Multiple Master Licenses can accommodate multiple budgetary or purchasing cycles, confine
administrators access to only their licenses, and distinguish between groups of licenses such as
those for different departments.
1-3
1 Licensing Overview
See Also
More About
• “Individual License Administration” on page 2-2
• “Designated Computer License Administration” on page 3-2
• “Network Named User License Administration” on page 4-2
• “Concurrent License Administration” on page 5-2
1-4
2
You can install MathWorks products on individual computers in one of two ways:
• Standard installation — You will need a MathWorks Account for standard online installation.
Follow the instructions in “Download and Install MATLAB”.
• Offline installation (install with a File Installation Key)— You will need the following:
• A MathWorks Account to retrieve the license file and File Installation Key associated with the
license from the License Center, and
• An Internet connection to download the installer and product installation files, which you will
then take to the offline machine.
Follow the instructions at “Download Products Without Installing” and “Install MathWorks
Products on Offline Computer”.
See Also
Related Examples
• “Install Products”
• “Update Your License”
External Websites
• License Center
2-2
3
Note Users on a Designated Computer license must be physically present to use the software. The
Designated Computer license does not allow remote access.
To install MathWorks products on an Designated Computer License, run the MathWorks product
installer. During installation, you log in to your MathWorks Account, select the license that you want
to install, and provide the information requested by the other installer dialog boxes. The installer
determines which products to install based on the license you specify.
You can install MathWorks products on individual computers in one of two ways:
• Standard installation — You will need a MathWorks Account for standard online installation.
Follow the instructions in “Download and Install MATLAB”.
• Offline installation (install with a File Installation Key)— You will need the following:
• A MathWorks Account to retrieve the license file and the File Installation Key associated with
the license. The File Installation Key identifies the products you can install. The Administrator
on the license can retrieve the File Installation Key from the License Center.
• An Internet connection to download the installer and product installation files, which you will
then take to the offline machine.
Follow the instructions at “Download Products Without Installing” and “Install MathWorks
Products on Offline Computer”.
See Also
Related Examples
• “Install Products”
• “Update Your License”
External Websites
• License Center
3-2
4
As the Administrator of a Network Named User license, you have two primary goals:
• Setting up an installation that optimizes accessibility to the products. See “Install License
Manager on License Server”.
• Ensuring that only authorized users have access to the products. See “Set Up Named User
Licensing” on page 4-2.
With Network Named User licenses, MathWorks uses an options file for the network license manager
to identify the specific Named Users to whom you have assigned right-to-use privileges. The options
file is a text file that contains option statements. An option statement begins with a keyword that
identifies the option, such as RESERVE, INCLUDE, EXCLUDE, GROUP, or HOST_GROUP.
Note Do not confuse your license file with your network license manager options file. The license file
contains the encrypted passcodes for each product you are licensed to install and run. The network
license manager options file is a text file that contains license manager option statements.
If you have a Network Named User license, after you install your products, you might need to:
• Check that the network license manager options file includes all licensed users — see “Check the
Options File” on page 4-2.
• Check that the DAEMON line in your license file includes the options file location — see “Make Sure
Your DAEMON Line Includes Your Options File” on page 4-3.
For more detailed information about creating network license manager options files, see the License
Administration Guide, available in PDF form in matlabroot/etc/LicenseAdministration.pdf,
where matlabroot represents your installation folder. This file is available only after you have
installed the network license manager.
As part of the installation process, the MathWorks installer creates a network license manager
options template file, named MLM.opt, in the etc subfolder of your top-level MATLAB® installation
folder. In this options template, the installer puts an INCLUDE line for each product you are licensed
to install and run. By default, the installer puts the user name of the person who performed the
installation in these INCLUDE lines. If you performed your own installation, the options file might not
need editing. However, if you performed the installation for another user, or if your license server is
4-2
Network Named User License Administration
installed on Linux® and you had root privileges when you performed the installation, you will need to
edit this options template.
For example, if your user name is sysadmin, the options file would look like this.
You must replace sysadmin in these INCLUDE statements with the user names of the licensed users.
Because the installer includes the GROUPCASEINSENSITIVE option in the options file and sets it to
ON, login names are not case sensitive. If multiple users are licensed for the same product, you must
create a separate INCLUDE line for each user or collect the users into a group, using the GROUP
syntax, and specify the name of the group in an INCLUDE line. The number of users must not exceed
the number of license keys available for that product. This example shows both methods.
Note If you edit the options file, make certain that there are no extra space characters at the end of
each INCLUDE line.
GROUPCASEINSENSITIVE ON
GROUP matlab_users tom judy mike jean brad
GROUP signal_users tom mike brad
INCLUDE MATLAB GROUP matlab_users
INCLUDE Signal_Toolbox GROUP signal_users
INCLUDE Optimization_Toolbox USER mike
INCLUDE Optimization_Toolbox USER jean
When the installer creates an options file during installation, it also adds the Options= syntax to the
DAEMON line in your license file. This syntax specifies the pathname of the options file.
For example, if your server is named thunderball and its mac address is 03:42:f8:1b:b2:72, the
SERVER and DAEMON lines in your license file would look like this:
See Also
Related Examples
• “Update Network License”
• “Borrow Licenses” on page 7-2
External Websites
• License Center
4-3
5
As Administrator for a Concurrent license, your primary goal is to set up an installation that optimizes
accessibility to the products. The fundamental tasks required to administer a Concurrent license are:
1 Determine how you want to configure the products for users — There are several possible
configurations. Decide whether users will install MATLAB on their computers or access MATLAB
over a network. See “Install Products on Client Machines”.
2 Install the software on the computers required by the configuration — You must install the
network license manager on a file server and, depending on your configuration, either install
MathWorks products on a file server or install the products on client computers. You can use the
MathWorks installer to perform all of these installations. See “Install Products on Client
Machines”.
Before you install MATLAB in a network installation, decide what type of configuration you want to
set up. This decision determines how many installations you need to perform. This topic describes
these options.
In a local client access configuration, you install the network license manager on a server and you
install MATLAB on each client computer. When users on client computers start MATLAB, it contacts
the license manager over the network to check out a license key.
To install MATLAB on client computers in your network, follow the instructions in “Install Products”.
5-2
Concurrent License Administration
In Network Concurrent User installations, you can set up a network access configuration by installing
MATLAB and other products on a file server and have client computers access products over the
network, or you can setup a local access configuration by installing products on each client computer.
In this scenario, clients communicate with the server only when they check out a license key.
Note You must activate the license for the installation before you run the installer. To retrieve the
license file needed for your configuration, go to the License Center at the MathWorks website.
You must provide the host ID of the computer on which you intend to run the network license
manager when requesting a license file. You specify the location of your license file during
installation.
If you have a Concurrent license, you can use the licensing timeout option to automatically return idle
license keys at your site. With license timeouts, the network license manager automatically frees
license keys that sit idle for a specified period of time, returning the licenses to the pool of available
license keys.
For example, when you start MATLAB and other products, such as toolboxes, you check out license
keys for these products. If you go home without exiting your MATLAB session, these licenses remain
checked out and are not available to other users. With timeouts enabled, after your licenses sit idle
for a specified period, the network license manager releases the license keys for all the products you
had been using and these keys become available to other users.
To take advantage of timeouts, you must specify the TIMEOUT option in the options file for the
network license manager. This options file is a text file that contains license manager options
statements, such as INCLUDE, EXCLUDE, and GROUP statements.
To enable timeouts:
1 Create an options file, if one does not exist, using any text editor. Name the options file MLM.opt
and put the file in the matlabroot/etc/$ARCH folder, where matlabroot represents your
installation folder and $ARCH represents a platform-specific folder. For example, on a Windows
computer, you might create the file
C:\Program Files\MATLAB\R2024a\etc\win64\MLM.opt
2 Add the TIMEOUT option to the options file, using the following syntax:
TIMEOUT feature seconds
For feature, specify MATLAB. You cannot specify separate timeout values for individual
MathWorks products, such as toolboxes.
For seconds, specify the amount of idle time you want to allow. The minimum value is 4 hours
(14,400 seconds). If you specify a timeout value that is smaller, the minimum value is used. For
example, to specify a five-hour time-out, enter the following in your options file.
5-3
5 Administering Concurrent Licenses
Under these conditions, the network license key(s) are returned but MATLAB remains open.
The timeout is recorded in the network license manager log file, as follows:
To resume a MATLAB session that has timed out, start using MATLAB again. If a license key is
available, MATLAB checks it out automatically. If a license key is not available, MATLAB issues a
warning and tries again. MATLAB will make 10 attempts before exiting.
Note If you return to a Simulink® session that has timed out, and no licenses are available, you
cannot run or modify a currently open model. These menu options are disabled until a Simulink
license key becomes available. You can, however, save a model in a Simulink session that has timed
out.
See Also
Related Examples
• “Borrow Licenses” on page 7-2
• “Install Products”
5-4
6
Note License administrators: For information about how to configure the network license manager
for use with MathWorks products on the cloud, see “Configure License Manager for MATLAB on
Cloud Platforms”.
If you do not know what type of license you have or what products you are licensed for, you can look
in your MathWorks Account:
If you do not have a MathWorks Account, you can create an account at https://www.mathworks.com/
mwaccount/register. You can then link the license you are using to your MathWorks Account or
purchase a license if you do not have one.
To determine whether your license is eligible to run MathWorks products on the cloud, consult the
following table.
6-2
License Requirements for MATLAB on Cloud Platforms
• On public clouds • Campus-Wide — License that belongs to your academic institution and
• In containers is for your use only.
• In Cloud Center • Individual — License that is in your name and is for your use only.
Note When running MATLAB on a virtual machine, make sure that the
MAC address that identifies the machine on the network is static
(unchangeable). Without a static MAC address, your machine might be
assigned a new one when it restarts. This new address counts toward the
maximum number of machines that your license permits you to run
MATLAB on, potentially causing you to exceed your license limit. The way
to obtain a static MAC address varies by cloud platform. For example:
• Azure — When you create a virtual network, the virtual network MAC
address is retained even when the virtual machine is in the
deallocated state.
• AWS — Use an Elastic Network Interface (ENI), which contains a
static MAC address attribute.
6-3
6 Licensing for MATLAB Running on the Cloud
• On public clouds • MATLAB Parallel Server license hosted by your organization using the
• In containers network license manager
• In Cloud Center • MATLAB Parallel Server cloud-based licensing. Users must be added
to the license by their license administrator in License Center. Users
who have the license already linked to their MathWorks Account do
not need to be added.
If you do not have an eligible MATLAB Production Server license, you can
use the MATLAB Production Server pay-as-you-go offerings on Azure or
AWS.
MATLAB Web App Server™ Your license must be:
See Also
Related Examples
• Use MATLAB in the Cloud
6-4
7
This topic describes how to borrow a Concurrent User or Named User license.
7 Borrow Network Licenses
Borrow Licenses
License Borrowing Overview
To provide license mobility, MathWorks supports license borrowing.
• This capability lets you use MathWorks products on computers that do not have a continuous
connection to the license server.
After you borrow a license, you can disconnect your computer from the network and continue to
use the products you have checked out until the borrow period expires.
Note Campus-Wide licenses, including Concurrent licenses, cannot use license borrowing.
Notes
• In license files with borrowing, the INCREMENT lines for products include the keyword
BORROW=720, where 720 is the maximum number of hours in the borrow period (you cannot
change this value). For example:
INCREMENT MATLAB MLM 17 30-jan-2025 5 52FCH63184G5 BORROW=720 \
DUP_GROUP=UH SN=220668
• The maximum borrow period of 720 hours is equal to 30 days.
After your license is enabled for borrowing, you will download a new license file.
2 On your license server, stop the network license manager.
3 On your license server, copy the SERVER and DAEMON lines from the existing license file,
matlabroot/etc/license.dat, where matlabroot represents your MATLAB installation
folder. For example, here are the SERVER and DAEMON lines from a license file:
SERVER mysystem 0012110gbc86 27000
DAEMON MLM C:\Program Files\MATLAB\R2024a\etc\win64\MLM.exe
4 Paste the SERVER and DAEMON lines that you copied from your existing license file at the top of
the new license file that includes the license borrowing capability.
7-2
Borrow Licenses
5 On your license server, replace the existing license file with the new license file.
6 Restart the network license manager.
Note Ensure that the client computer has a network connection to the license server.
To turn on the menu option for Borrow Products in the Licensing menu:
After you turn on the menu option for License Borrowing the first time, it remains available any
time you start MATLAB.
2 Restart MATLAB.
3 Locate the Borrow Products option in the Licensing menu.
1 Start MATLAB.
7-3
7 Borrow Network Licenses
When you reopen MATLAB, your borrowed products can be used away from your network.
Continue using the borrowed products until the borrow period expires. If you reconnect to your
network before the end of the borrowing period, see “Return Borrowed Licenses Early” on page 7-
4.
1 Start MATLAB.
2 On the Home tab, in the Resources section, click Help.
3 Under Licensing, click Borrow Products.
4 Select Borrow products automatically as you work with them.
5 Specify the borrow period: from 1 day (default) to 30 days.
6 Click Turn On Auto Borrow.
7 Work in MATLAB as you would normally, performing the tasks you want to perform when you are
disconnected from the network. As you use products, MATLAB borrows the licenses for them
automatically.
When you have finished working with all the products you want to borrow, click Turn Off Auto
Borrow.
8 Close MATLAB.
9 Disconnect your computer from the network.
When you reopen MATLAB, your borrowed products can be used away from your network.
Continue using the borrowed products until the borrow period expires. If you reconnect to your
network before the end of the borrowing period, see Return Borrowed Licenses Early in the next
section.
7-4
Borrow Licenses
4 Select Return borrowed products early. The dialog box displays a list of currently borrowed
products.
5 Specify the product licenses you want to return early. By default, all borrowed product licenses
are selected. Deselect any products you do not want to return.
6 Click Return.
Note You cannot borrow licenses and then return them in the same MATLAB session. You must quit
MATLAB and restart it before you can return the licenses.
The network licensing manager provides tools that you can use to monitor the status of borrowed
licenses in your network configuration. You can use the LMTOOLS application or the lmstat
command.
Use LMTOOLS Application on Windows Systems
7-5
7 Borrow Network Licenses
MLM: UP v11.16.2
Feature usage info:
juser myserver DESKTOP-4SPTFG0 (v45) (myserver/27000 102), start Thu 12/9 15:41
juser myserver DESKTOP-4SPTFG0 (v45) (myserver/27000 201), start Thu 12/9 15:43 (linger: 807316 / 807360)
Note MATLAB Compiler™: License status information may contain linger even when MATLAB
Compiler is not being borrowed.
1 Log in to your license server and open a DOS command window. One way to open the DOS
command window is to select the Run option from the Start menu, type cmd in the text entry
field, and then click OK.
2 Navigate to the matlabroot\etc\$ARCH folder, where matlabroot represents the name of
your MATLAB installation and $ARCH represents a platform-specific folder.
3 Run the lmutil command specifying lmstat as an argument. (On Windows computers,
FlexNet® packages all its license management utilities into one program, lmutil.)
The following example uses the -a option to display all the information returned by lmstat.
Note that you must also use the -c option to specify the name of your license file. For more
information about lmstat, see the FlexNet End User’s Guide.
lmutil lmstat -a -c "C:\Program Files\MATLAB\R2024a\etc\license.dat"
In the status information returned by lmstat, each entry in the list for a product shows the total
number of licenses for the product and tells how many licenses are currently checked out. For
borrowed licenses, the entry for the product includes the keyword (linger:XXX), where XXX
specifies the borrow period in seconds.
7-6
Borrow Licenses
Note MATLAB Compiler: License status information may contain linger even when MATLAB
Compiler is not being borrowed.
lmstat -a -c /usr/local/MATLAB/R2024a/etc/license.dat
You can control various aspects of license borrowing behavior using an options file for the network
license manager. An options file is a text file that contains option statements. Each option statement
begins with a keyword that identifies the option. The following table lists the options you use to
control aspects of license borrowing. For more information about these options, see the FlexNet End
User’s Guide. To see an example of an options file, see the example in the next topic.
BORROW_LOWWATER MATLAB 3
Specify which users can borrow Use the INCLUDE_BORROW option.
licenses for a particular product.
For example, to allow the user Fred to borrow a license for
the Image Processing Toolbox™, use this syntax:
7-7
7 Borrow Network Licenses
MAX_BORROW_HOURS image_toolbox 72
To illustrate using an options file to control license borrowing behavior, this example uses an options
file to exclude a user from borrowing a license for a specific product:
An options file is a text file that contains options statements. Using any text editor, create a file
that contains the following line. You can give the options file any name and store it in any
convenient folder.
On your license server, use any simple text editor to edit your license file, adding the options=
keyword to the DAEMON line, as follows. Be sure to use the line continuation character (\) if the
DAEMON line extends beyond a single line.
See Also
More About
• “Network Named User License Administration” on page 4-2
7-8
Borrow Licenses
7-9