Step #2: Configuring NGC CLI

  1. Open the console using the left-hand navigation pane.

    base-command-039.png

  2. The console session will open in a new window.

    base-command-040.png

  3. Run the command below to start NGC configuration.

    Copy
    Copied!
                

    $ ngc config set


  4. Enter your API key as shown below. If you do not already have an NGC API key stored securely somewhere, you can generate a new key by following these steps.

    Copy
    Copied!
                

    Enter API key [no-apikey]. Choices: [<VALID_APIKEY>, 'no-apikey']: thisisnotarealkeyabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzthisisnotarealkey


  5. Set the CLI output format type to ascii and press enter.

    Copy
    Copied!
                

    Enter CLI output format type [ascii]. Choices: [ascii, csv, json]: ascii


  6. Set the Org to the value from your onboarding email (of the format nv-launchpad-bc*) and press enter. Note that the Org should be listed in the Choice array as shown below.

    Copy
    Copied!
                

    Enter org [no-org]. Choices: ['nv-launchpad-bc']: nv-launchpad-bc


  7. Set the Team to no-team and press enter.

    Copy
    Copied!
                

    Enter team [no-team]. Choices: ['fake-team', 'no-team']: no-team


  8. Set the ACE (of the format nv-launchpad*) and press enter. Note that the ACE should be listed in the Choice array as shown below.

    Copy
    Copied!
                

    Enter ace [no-ace]. Choices: ['nv-launchpad-bc-sjc-ace', 'no-ace']: nv-launchpad-bc-sjc-ace


  9. The configuration file will now save.

    Copy
    Copied!
                

    Successfully saved NGC configuration to /home/nvidia/.ngc/config


  10. Confirm your settings by running an ngc diag all. A sample run and associated output is show below.

    Copy
    Copied!
                

    $ ngc diag all Checking configuration validation... Checking general information... Timestamp: 2022-05-11 11:32:27 UTC User name: Demo User Checking Operating System... Type: Linux Version: 5.4.0-91-generic Checking Process Hierarchy... Parent Name: ngc Grandparent Name: bash Checking disk usage for /home/nvidia... Total: 465.63 GB Free: 273.39 GB Used: 41.3% Checking current directory (/home/nvidia) size... Size: 132.31 GB Checking memory usage... Total: 16 GB Free: 390.84 MB Used: 64.1% Checking file permissions... set umask: 0o77 Checking workspace mounts... Checking set NGC CLI environment variables... None Checking unset NGC CLI environment variables... NGC_CLI_ACE: <value not set> NGC_CLI_API_KEY: <value not set> NGC_CLI_FORMAT_TYPE: <value not set> NGC_CLI_HOME: <value not set> NGC_CLI_ORG: <value not set> NGC_CLI_TEAM: <value not set> NGC_CLI_PUBLISH_SERVICE_URL: <value not set> NGC_CLI_PUBLISH_ENABLE: False NGC_CLI_DEPLOYMENT_ENABLE: False NGC_CLI_JOB_LABELS: False NGC_CLI_USER_INVITATIONS: False Checking linux proxies environment variables... http_proxy: None https_proxy: None ftp_proxy: None Checking CLI installation... CLI version: NGC CLI 2.9.0 Checking Docker... Runtime Information: Runtime information is unavailable. Checking API gateway connectivity... API URL: https://api.ngc.nvidia.com API Connectivity: SUCCESS Checking authentication... Authentication: SUCCESS Checking API connectivity (container registry)... Container Registry URL: https://nvcr.io Container Registry Connectivity: SUCCESS Checking API connectivity (model registry)... Model Registry URL: https://models.ngc.nvidia.com Model Registry Connectivity: SUCCESS Checking data storage connectivity... Data Storage URL: https://nv-launchpad-bc-sjc-ace.7ze9nrwm.dss.ace.nvbcp.com Data Storage Connectivity: SUCCESS Checking external IP... Global IP Address: 1.2.3.4 Checking Current configuration...apikey: ********************************************************************************lkey - source: user settings fileformat_type: ascii - source: user settings fileorg: nv-launchpad-bc - source: user settings fileace: nv-launchpad-bc-sjc-ace - source: user settings file Checking user information... ID: 101526 Name: Demo User Email: demouser@fake-email.com Checking user org roles... nv-launchpad-bc: ['BASE_COMMAND_USER', 'REGISTRY_READ', 'USER_READ'] Checking user team roles... fake-team: ['ROLE_1', 'ROLE_2']


© Copyright 2022-2023, NVIDIA. Last updated on Jan 10, 2023.