1. Install with the Command Line

SDK Manager now supports running a command line installation on a pure headless environment without any graphical context, (i.e., Docker, PuTTY, Ubuntu Server, etc.). There is no longer a requirement for any graphical context to install via the command line.

To run NVIDIA SDK Manager from a terminal in Linux, do the following: 

  1. Download and run SDK Manager on your host machine.

  2. Launch SDK Manager from terminal, using the parameters below to run an installation from the command line.

1.1. General Arguments

Parameter Description
-h, --help

Displays this usage guide.

--ver

Outputs the version of the installed SDK Manager client.

--query interactive | noninteractive

Optional. Prints all options available for the user.

  • interactive – gets the install command by inquiry session flow.
  • noninteractive – prints all options available for the user.

Default is noninteractive.

Example:

--query interactive --logintype devzone 
--query noninteractive --logintype devzone 
--query --user john.doe@example.com --logintype nvonline
--query --offline --downloadfolder /my-mounted-drive/Shared/nvidia/sdk-manager-download-folder
--showallversions
Optional. Prints all available product versions for the user. If it is not set, SDK Manager will only list the primary product versions.
--logs

Optional. Set this option to export the log files when the install process is complete. Logs will be exported to downloadfolder.

--exitonfinish

Optional. Automatically exit from SDK Manager when the install/uninstall session is finished without user input. Intended for scripts/automation usage.

--user user_email

Mandatory. Set the user email to login. Valid only for NVONLINE users with partners.nvidia.com accounts.

--password string

Optional. Set the user login password. Valid only for NVONLINE users with partners.nvidia.com accounts.

--logintype devzone | nvonline 

Optional. Set the login server (devzone or nvonline).

Default is devzone.

--staylogin true | false

Optional. Keep the user account logged in for the next running session.

--logout

Optional. Logout the user account from SDK Manager.

--offline

Optional. This option allows you to skip logging into your NVIDIA account, and instead installs the SDK from a pre-downloaded location. Used with the --downloadfolder argument.

DRIVE example:

--offline --host --target DDPX

Jetson example:

--offline --host --target P3448
--downloadfolder path

Optional. This option allows you to set the download folder for the files. When used with --offline, this option specifies where the downloaded SDK components should be stored.

Example:

--downloadfolder /my-mounted-drive/Shared/nvidia/sdk-manager
--archivedversions
Optional. Use this option to display only archived SDK versions.
--cli install | uninstall | downloadonly

Mandatory. This allows SDK Manager to run install, uninstall, or download without displaying a user interface. Use this argument to set the requested action.

--settings 
Optional. Configure SDK Manager settings in the terminal.
--sudopassword string

Optional. Set the sudo password to skip the authentication prompt.

Note that the password is in clear text, and visible in the terminal window.

--datacollection enable | disable 

Optional. Set to enable or disable usage data collection.

--exportlogs path 

Optional. This option will export all the installation log files to the specified path in packaged format. Logs will be exported to the download folder if it is not provided.

--checkforupdates 

Optional. Check for SDK Manager updates.

1.2. Additional Arguments for Install/Uninstall

Parameter Description
--product DRIVE | Jetson | Clara | DOCA

Mandatory. Set the product to be installed in command line mode.

Example: 

--product DRIVE

OR

--product Jetson

OR

--product Clara

OR

--product DOCA
--version string

Mandatory. Set the product version. Use --query to get available version values.

DRIVE: The version string contains the version, SDK/PDK, edition and build number, separated by '_'.

Example:

--version OS_5.1.12.0_SDK

Jetson: Set the version of the product to be installed or uninstalled.

Example:

--version 4.3

Clara: Set the version of the product to be installed or uninstalled.

Example:

--version 1.5

DOCA: Set the version of the product to be installed or uninstalled.

Example:

--version 1.0
--targetos target_os

Mandatory. Set the target hardware operating system.

Example: 

--targetos Linux
--host

Optional. This parameter specifies that the host side components need to be installed.

--target target_hardware

Optional. Use this argument if components for the specified target hardware need to be installed. Use the hardware code name.

DRIVE example:

--target E3550

Jetson example:

--target P3448-0000

Clara example:

--target P2888-0001

DOCA example:

--target BLUEFIELD2_DPU_TARGETS
--flash all | a | b | ab | skip

Optional. Set the flashing operation mode, and which of the Tegras should be flashed (a, b, ab, all or skip).

All refers to all Tegras available on the target hardware. Default is all.

--additionalsdk additional_sdk_title

Optional. Specify additional SDKs to install. Multiple entries are allowed.

--select section_or_group_title

Optional. Select the specified section or group to the installation list. Multiple entries are allowed.

--deselect section_or_group_title

Optional. Deselect the specified section or group from the installation list. Multiple entries are allowed.

--license accept

Optional. Set this option to accept the terms and conditions of the NVIDIA software licenses.

--targetimagefolder path

Optional. This option allows you to set the host location of the target hardware image for flashing.

--responsefile string

Optional. Set the path to the response file.

For more information, see Response File below.

2. Example

$ sdkmanager [--cli install|uninstall] [cli options] ... 
$ sdkmanager [--help]

For example, to install DRIVE OS 5.1.12.0 Linux via the command line, use the following:

sdkmanager --cli install --user john.doe@example.com --logintype nvonline --product DRIVE --version OS_5.1.12.0_SDK --targetos Linux --host --target E3550 --flash all 

Meanwhile, a Jetson 4.3 example would be:

sdkmanager --cli install --user john.doe@example.com --logintype devzone --product Jetson --version 4.3 --targetos Linux --host --target P3448-0000 --flash all  

For a Clara 1.5 example, use the following:

sdkmanager --cli install --user john.doe@example.com --logintype devzone --product Clara --version 1.5 --targetos Linux --host --target P2888-0001 --flash all 

For a DOCA 1.0 example, use the following:

sdkmanager --cli install --logintype devzone --product DOCA --host --target BLUEFIELD2_DPU_TARGETS --targetos Linux --version 1.0 --flash all

For more examples, see the following sections.

2.1. Set and Run with Command Options

  1. Run SDK Manager with the below options to print all options available for the user.

    For users from developer.nvidia.com:

    $ sdkmanager --query noninteractive --logintype devzone

      Note:  

    Please refer to Developer Zone User Login to complete your devzone login before proceeding.  

    For users from partners.nvidia.com:

    $ sdkmanager --query --user john.doe@example.com --logintype nvonline

    This outputs the full list of command options for all available SDKs for your user account.

  2. You can also run an interactive query to print the available options from a set of inquiry steps.

    For users from developer.nvidia.com:

    $ sdkmanager --query interactive --logintype devzone

    For users from partners.nvidia.com:

    $ sdkmanager --query interactive --user john.doe@example.com --logintype nvonline

  3. Refer to the syntax parameters in General Arguments and Additional Arguments for Install/Uninstall, then run SDK Manager with your own customized command.

2.2. Developer Zone User Login

When running commands with --logintype devzone, you need to log in to developer.nvidia.com first.

Open the highlighted URL in a browser, enter your credentials for your NVIDIA Developer account, and click Login. Once completed, SDK Manager will start.

2.3. Review Licenses and Select Components

  1. To review the license, you can use the arrow keys or mouse to scroll up and down the content.

  2. To confirm your answer, use Tab to switch between the Yes or No options, then press Enter. You can also use a mouse click to confirm the option.

  3. You must view and accept all licenses one by one to continue to the next step. If you wish to bypass the license review, run with the command option:

    --license accept

  4. In the component selection screen, SDK Manager allows you to select sections or groups you wish to install.

    You can use the list of keys below to do the selection:

    Key Description
    Tab Change focus to next window
    Up/Down Change item selection
    Left/Right Expand/collapse grouped items
    Space Check/uncheck selected checkbox
    Enter Submit selection

2.4. Installation

  1. Before the installation begins, SDK Manager prompts you to enter your sudo password.

  2. The display shows the progress of the download and installation of the software.

  3. You can toggle between the installation and terminal panels. The terminal panel displays detailed information about the download and installation, with any errors highlighted.

2.5. Response File

You can use a response file to run SDK Manager in automated and unattended sessions. This will automatically set the command line options and parameters for your command line installation.

The samples can be found in the following location:

  • DRIVE users (download here)

    /opt/nvidia/sdkmanager/sdkm_responsefile_sample_drive.ini
  • Jetson users (download here)

    /opt/nvidia/sdkmanager/sdkm_responsefile_sample_jetson.ini
  • Clara users (download here)

    /opt/nvidia/sdkmanager/sdkm_responsefile_sample_clara.ini
  • DOCA users (download here)
    /opt/nvidia/sdkmanager/sdkm_responsefile_sample_doca.ini

To run SDK Manager with a response file, do the following:

  1. Copy the sample file to your selected location, and enable it for editing.

  2. Edit the arguments and values as needed.

  3. Run SDK Manager with the --responsefile option. For example:

    $ sdkmanager --cli install --responsefile <response_file_path>

 

Previous | Next

  Previous Topics     Next Topics  

Home    

System Requirements    

Release Notes    

Download and Run SDK Manager    

Offline Install    

SDK Manager Settings    

User Account Membership Settings    

 

Notices

Notice

THE INFORMATION IN THIS GUIDE AND ALL OTHER INFORMATION CONTAINED IN NVIDIA DOCUMENTATION REFERENCED IN THIS GUIDE IS PROVIDED “AS IS.” NVIDIA MAKES NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO THE INFORMATION FOR THE PRODUCT, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. Notwithstanding any damages that customer might incur for any reason whatsoever, NVIDIA’s aggregate and cumulative liability towards customer for the product described in this guide shall be limited in accordance with the NVIDIA terms and conditions of sale for the product.

THE NVIDIA PRODUCT DESCRIBED IN THIS GUIDE IS NOT FAULT TOLERANT AND IS NOT DESIGNED, MANUFACTURED OR INTENDED FOR USE IN CONNECTION WITH THE DESIGN, CONSTRUCTION, MAINTENANCE, AND/OR OPERATION OF ANY SYSTEM WHERE THE USE OR A FAILURE OF SUCH SYSTEM COULD RESULT IN A SITUATION THAT THREATENS THE SAFETY OF HUMAN LIFE OR SEVERE PHYSICAL HARM OR PROPERTY DAMAGE (INCLUDING, FOR EXAMPLE, USE IN CONNECTION WITH ANY NUCLEAR, AVIONICS, LIFE SUPPORT OR OTHER LIFE CRITICAL APPLICATION). NVIDIA EXPRESSLY DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY OF FITNESS FOR SUCH HIGH RISK USES. NVIDIA SHALL NOT BE LIABLE TO CUSTOMER OR ANY THIRD PARTY, IN WHOLE OR IN PART, FOR ANY CLAIMS OR DAMAGES ARISING FROM SUCH HIGH RISK USES.

NVIDIA makes no representation or warranty that the product described in this guide will be suitable for any specified use without further testing or modification. Testing of all parameters of each product is not necessarily performed by NVIDIA. It is customer’s sole responsibility to ensure the product is suitable and fit for the application planned by customer and to do the necessary testing for the application in order to avoid a default of the application or the product. Weaknesses in customer’s product designs may affect the quality and reliability of the NVIDIA product and may result in additional or different conditions and/or requirements beyond those contained in this guide. NVIDIA does not accept any liability related to any default, damage, costs or problem which may be based on or attributable to: (i) the use of the NVIDIA product in any manner that is contrary to this guide, or (ii) customer product designs.

Other than the right for customer to use the information in this guide with the product, no other license, either expressed or implied, is hereby granted by NVIDIA under this guide. Reproduction of information in this guide is permissible only if reproduction is approved by NVIDIA in writing, is reproduced without alteration, and is accompanied by all associated conditions, limitations, and notices.

Trademarks

NVIDIA, the NVIDIA logo, and Bluefield-2, CLARA, cuBLAS, CUDA, CUDA-GDB, CUDA-MEMCHECK, cuDNN, cuFFT, cuSPARSE, DIGITS, DGX, DGX-1, DGX Station, DOCA SDK, NVIDIA DRIVE, NVIDIA DRIVE AGX, NVIDIA DRIVE Software, NVIDIA DRIVE OS, NVIDIA Developer Zone (aka "DevZone"), GRID, Jetson, NVIDIA Jetson Nano, NVIDIA Jetson AGX Xavier, NVIDIA Jetson TX2, NVIDIA Jetson TX2i, NVIDIA Jetson TX1, NVIDIA Jetson TK1, Kepler, NGX, NVIDIA GPU Cloud, Maxwell, Multimedia API, NCCL, NVIDIA Nsight Compute, NVIDIA Nsight Eclipse Edition, NVIDIA Nsight Graphics, NVIDIA Nsight Systems, NVLink, nvprof, Pascal, NVIDIA SDK Manager, Tegra, TensorRT, Tesla, Visual Profiler, VisionWorks and Volta are trademarks and/or registered trademarks of NVIDIA Corporation in the United States and other countries. Other company and product names may be trademarks of the respective companies with which they are associated.