Main Content

mosadm install-matlab

Install MATLAB on MATLAB Online Server

Since R2023a

collapse all in page

    Syntax

    mosadm install-matlab
    mosadm install-matlab option1 ... optionN

    Description

    example

    mosadm install-matlab installs the latest version of MATLAB® for use in MATLAB Online Server™. By default, this command installs MATLAB to the /MATLAB folder of your local machine.

    example

    mosadm install-matlab option1 ... optionN installs MATLAB using the specified configuration options. For example, you can specify the folder in which to install MATLAB, the MATLAB release you want to install, and add-on products you want to include in your installation.

    Note

    • This command requires an Internet connection. If your machine is not connected to the Internet, follow the instructions in Install MathWorks Products on Offline Computer instead.

    • To use this command, you must have ownership of the folder into which you are installing MATLAB, and you must have read and write privileges on the folder. If the folder does not exist, then you must have ownership of the parent folder so that the installation folder can be created.

    Examples

    collapse all

    Install the latest version of MATLAB into the default /MATLAB folder on your machine. If this folder does not exist, the mosadm install-matlab command creates it.

    ./mosadm install-matlab

    Install MATLAB R2024a and Database Toolbox™ into the /usr/local/MATLAB folder of your local machine.

    ./mosadm install-matlab --matlab-root /usr/local/MATLAB --matlab-version R2024a --products "MATLAB Database_Toolbox"

    Input Arguments

    collapse all

    One or more configuration options, specified as strings corresponding to valid configuration options from these tables.

    Specific to mosadm install-matlab

    OptionDescription
    --matlab-root filePath

    Destination path in which to install MATLAB. Specify filePath as a valid path on the machine.

    Default: /MATLAB

    --matlab-version releaseVersion

    MATLAB release to install, specified as a string of the form R20NNx.

    Example: R2024a

    --products "product1 ... productN"

    List of products to install, specified as a space-separated list. When specifying multiple products, replace spaces within product names with underscores and enclose the product list in quotes.

    Example: "MATLAB Database_Toolbox Parallel_Computing_Toolbox"

    Default: MATLAB

    Common to All mosadm Commands

    OptionDescription

    --charts-dir chartsDir

    Name of the MATLAB Online Server charts folder to use. This folder contains the Helm® charts of the server.

    Specify chartsDir as an absolute path or a path relative to the MATLAB Online Server root folder mosRoot.

    Example: matlab_online_server/charts.

    Default: mosRoot/charts

    --data-dir dataDir

    Name of the MATLAB Online Server data folder to use.

    Specify dataDir as an absolute path or a path relative to the MATLAB Online Server root folder mosRoot.

    Example: matlab_online_server/data.

    Default: mosRoot/data

    --dry-run

    Print out the commands that would have run without this option specified but do not run the operation. Specify this option to test that the operation produces the expected results before actually executing it.

    --help, -h, help

    		Output help for mosadm install-matlab to the command line.

    --kube-config configFilePath

    Path to the Kubernetes® cluster configuration file. Specify configFilePath as an absolute path or a path relative to the MATLAB Online Server root folder mosRoot.

    Example: /etc/kubernetes/admin.conf

    By default, configFilePath is empty and Kubernetes obtains the cluster configuration from the KUBECONFIG environment variable (if specified) or the ~/.kube/config file. If you run mosadm install-matlab with sudo, then ~/.kube/config is equivalent to /root/.kube/config.

    --mos-root rootDir

    MATLAB Online Server root folder, specified as an absolute path or a path relative to the current folder, that is, the folder in which you can run mosadm commands.

    Default: . (current folder)

    --overrides-dir overridesDir

    Name of the MATLAB Online Server overrides folder to use.

    Specify overridesDir as an absolute path or a path relative to the MATLAB Online Server root folder, mosRoot.

    Example: matlab_online_server/overrides

    Default: mosRoot/overrides

    --quiet, -q

    Print only the most useful or relevant output from the mosadm install-matlab command.

    --skip-log-file

    Skip creating the install.log file and logging data about the mosadm install-matlab operation to this file.

    --skip-prompt, -y

    Force acceptance of the terms of use for the mosadm install-matlab and skip any command-line prompts normally provided when calling this command.

    --tmp-dir tempDirName

    Name of MATLAB Online Server temporary folder to use.

    Specify tempDirName as an absolute path or a path relative to the temporary folder.

    By default, mosadm install-matlab generates a new temporary folder every time you run the command.

    --verbose

    Output extra details about the mosadm install-matlab operation to the command line.

    Version History

    Introduced in R2023a

    See Also