Launch the administration tool/CLI to manage the operationalization configuration

Applies to: Machine Learning Server, Microsoft R Server

This article describes how to launch the tool used to manage the web and compute nodes for Machine Learning Server. These nodes enable you to operationalize your analytics with Machine Learning Server.

The tool you use to set up and manage your configuration depends on your version:

  • In Machine Learning Server 9.3 and later, use the command-line interface (CLI).
  • In versions 9.0 - 9.2, use the Administration Utility.

With this tool, you can:

Machine Learning Server 9.3 and later: Administration with Azure CLI

In this release, use the admin extension of the Azure CLI to set up and manage your Machine Learning Server node configuration.

Important

  • You do not need an Azure subscription to use this CLI.
  • This CLI is installed with Machine Learning Server and runs locally.
  1. Launch a DOS command line, powershell window, or terminal window with administrator privileges.

  2. Call the help function to verify that Administration CLI is working properly. At the command prompt, enter:

    # With elevated privileges, run the following commands.
    az ml admin --help
    

You must first set up your nodes before running any other admin extension commands in the CLI. For a speedy setup of a one-box configuration, use az ml admin bootstrap.

Machine Learning Server 9.2: Administration utility

These instructions describe how to launch the Administrator Utility on Machine Learning Server 9.2.

To launch the 9.2 Administration Utility:

  • On Windows, right-click the "Administration Utility" program icon in the Start menu, and then click "Run as Administrator".

    Note

    If the default powershell execution policy for your organization is "Restricted", the shortcut may not work. To get around this issue, either change the execution policy to "Unrestricted", or run the following in a command-line window with administrator privileges:
    cd C:\Program Files\Microsoft\ML Server\R_SERVER\o16n
    dotnet Microsoft.MLServer.Utils.AdminUtil\Microsoft.MLServer.Utils.AdminUtil.dll

  • On Linux, run the following commands with root or sudo privileges:

    cd /opt/microsoft/mlserver/9.2.1/o16n
    sudo dotnet Microsoft.MLServer.Utils.AdminUtil/Microsoft.MLServer.Utils.AdminUtil.dll
    

Also read about the command-line switches to the administration utility.

R Server 9.1: Administration utility

These instructions describe how to launch the Administrator Utility on Machine Learning Server 9.1.

To launch the 9.1 Administration Utility:

  • On Windows, right-click the "Administration Utility" program icon in the Start menu, and then click "Run as Administrator".

    Note

    If the default powershell execution policy for your organization is "Restricted", the shortcut may not work. To get around this issue, either change the execution policy to "Unrestricted", or run the following in a command-line window with administrator privileges:
    cd <r-home>\deployr
    dotnet Microsoft.RServer.Utils.AdminUtil\Microsoft.RServer.Utils.AdminUtil.dll
    Find r-home by running normalizePath(R.home()) in the R console.

  • On Linux, run the following commands with root or sudo privileges:

    cd /usr/lib64/microsoft-r/rserver/o16n/9.1.0/
    sudo dotnet Microsoft.RServer.Utils.AdminUtil/Microsoft.RServer.Utils.AdminUtil.dll
    

Also read about the command-line switches to the administration utility.

R Server 9.0: Administration utility

These instructions describe how to launch the Administrator Utility on Machine Learning Server 9.0.

To launch the 9.0 Administration Utility:

  • On Windows, right-click the "Administration Utility" program icon in the Start menu, and then click "Run as Administrator".

    Note

    If the default powershell execution policy for your organization is "Restricted", the shortcut may not work. To get around this issue, either change the execution policy to "Unrestricted", or run the following in a command-line window with administrator privileges:
    cd <r-home>\deployr
    dotnet Microsoft.DeployR.Utils.AdminUtil\Microsoft.DeployR.Utils.AdminUtil.dll
    Find r-home by running normalizePath(R.home()) in the R console.

  • On Linux, run the following commands with root or sudo privileges:

    cd /usr/lib64/microsoft-r/rserver/o16n/9.0.1/
    sudo dotnet Microsoft.DeployR.Utils.AdminUtil/Microsoft.DeployR.Utils.AdminUtil.dll
    


Command-line switches

The following command-line switches are available for the administration utility installed with R Server 9.0 - 9.1 and Machine Learning Server 9.2.1.

Switch Description Introduced in version
-silentoneboxinstall password uris

-silentinstall password uris
Sets up a one-box configuration silently, sets an admin password, and in 9.2 allows you to specify compute node URIs or IP ranges. A password is required. For example:

-silentinstall myPass123 http://1.1.1.1:12805,http://1.0.1.1-3:12805
9.1,
URIs in 9.2
-silentwebnodeinstall password uris Configures a web node silently, sets an admin password, and in 9.2 allows you to specify compute node URIs or IP ranges. A password is required. For example:

-silentwebnodeinstall myPass123 http://1.1.1.1:12805,http://1.0.1.1-3:12805
9.1,

URIs in 9.2
-silentcomputenodeinstall Configures a compute node silently. For example:

-silentcomputenodeinstall
9.1
-setpassword password Sets the password. Cannot be used
if LDAP or AAD was configured. For example:

-setpassword myPass123
9.1
-preparedbmigration filePath Migrates the data from current database to a different database schema. Takes the path to the web node’s appsetting.json file as an argument. This is uncommonly needed as a step when upgrading. For example:

-preparedbmigration <web-node-dir>/appsettings.json
9.1
-encryptsecret Secret CertificateStoreName CertificateStoreLocation CertificateSubjectName Silently encrypts secrets. For example:

-encryptsecret theSecret Store Location Subject
9.1