fleet-command¶

Fleet Command Commands

usage: ngc fleet-command [--debug] [--format_type <fmt>] [-h]  ...

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

fleet-command¶

: Possible choices: apikey, appconfig, application, component, deployment, fc, location, log, metric, remote, settings, usage

Sub-commands¶

apikey¶

Fleet Command API Key Commands

ngc fleet-command apikey [--debug] [--format_type <fmt>] [-h]  ...

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

apikey¶

: Possible choices: info, set

Sub-commands¶

set¶

Set the apikey for private helm, model and container registries. Command will prompt for API key.

ngc fleet-command apikey set [--debug] [--format_type <fmt>] [-h]

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

info¶

Show private registry apikey status.

ngc fleet-command apikey info [--debug] [--format_type <fmt>] [-h]

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

fc (usage)¶

Fleet Command GPU Usage Commands

ngc fleet-command fc [--debug] [--format_type <fmt>] [-h]  ...

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

usage¶

: Possible choices: info, list

Sub-commands¶

info¶

Show GPU counts and Log Storage details.

ngc fleet-command fc info [--debug] [--format_type <fmt>] [-h]

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

list¶

Show the list if GPU's under management.

ngc fleet-command fc list [--column <column>] [--debug] [--format_type <fmt>]
                          [-h]

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--column

Specify output column as column[=header]. The header is optional. The default is: locationName[='Location Name']. Valid columns are: nodeName[='Node Name'], totalGpuCount[='Total GPU Count'], managedGpus[='Managed GPUs']. Use quotes with spaces. Multiple column arguments are allowed.

appconfig¶

Fleet Command Application Configuration Commands

ngc fleet-command appconfig [--debug] [--format_type <fmt>] [-h]  ...

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

appconfig¶

: Possible choices: create, download, info, list, remove, update

Sub-commands¶

info¶

Show details for the specified appconfig.

ngc fleet-command appconfig info [--debug] [--format_type <fmt>] [-h] <target>

Positional Arguments¶

<target>: appconfig name.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

remove¶

Remove the specified appconfig.

ngc fleet-command appconfig remove [--debug] [--format_type <fmt>] [-h] [-y]
                                   <target>

Positional Arguments¶

<target>: appconfig name.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

-y, --yes

Automatically say yes to all interactive questions.

list¶

List appconfig(s).

ngc fleet-command appconfig list [--column <column>] [--debug]
                                 [--format_type <fmt>] [-h]
                                 [<target>]

Positional Arguments¶

<target>: appconfig(s) to list. This argument supports Unix glob style pattern matching. If no target appconfig is given, all visible appconfigs will be listed.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--column

Specify output column as column[=header], header is optional, default is name[=Name]. Valid columns are name[=Name], creationTimestamp[="Create Date"]. Use quotes with spaces. Multiple column arguments are allowed.

download¶

Download the appconfig yaml contents to a file.

ngc fleet-command appconfig download [--debug] [--dest <path>]
                                     [--format_type <fmt>] [-h]
                                     <target>

Positional Arguments¶

<target>: appconfig name.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--dest

Destination to download the target appconfig yaml. Default: .

create¶

Create a new appconfig.

ngc fleet-command appconfig create [--debug] --filename <path>
                                   [--format_type <fmt>] [-h]
                                   <target>

Positional Arguments¶

<target>: appconfig name.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

Required named arguments¶

--filename: appconfig filename - Provide the path to the appconfig yaml file.

update¶

Update the existing appconfig.

ngc fleet-command appconfig update [--debug] --filename <path>
                                   [--format_type <fmt>] [-h]
                                   <target>

Positional Arguments¶

<target>: appconfig name.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

Required named arguments¶

--filename: appconfig filename - Provide the path to the appconfig yaml file.

application¶

Fleet Command Application Commands

ngc fleet-command application [--debug] [--format_type <fmt>] [-h]  ...

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

application¶

: Possible choices: create, info, list, remove, update

Sub-commands¶

info¶

Show details for the specified application.

ngc fleet-command application info [--debug] [--format_type <fmt>] [-h]
                                   <target>

Positional Arguments¶

<target>: Helm name.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

remove¶

Remove the specified application.

ngc fleet-command application remove [--debug] [--format_type <fmt>] [-h] [-y]
                                     <target>

Positional Arguments¶

<target>: Helm name.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

-y, --yes

Automatically say yes to all interactive questions.

list¶

List Application(s).

ngc fleet-command application list [--column <column>] [--debug]
                                   [--display-name <string>]
                                   [--format_type <fmt>] [-h]

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--column

Specify output column as column[=header], header is optional, default is displayName[=Display Name]. Valid columns are displayName[="Display Name"], name[="Helm Name"], description[=Description]. Use quotes with spaces. Multiple column arguments are allowed.

--display-name

Search for applications with the specified display name. This argument supports Unix glob style pattern matching.

create¶

Create a new application.

ngc fleet-command application create [--debug] --desc <string> --display-name
                                     <string> [--format_type <fmt>]
                                     [--git-reference <string>]
                                     [--git-repository-path <string>]
                                     [--git-repository-url <string>]
                                     [--helm <string>]
                                     [--helm-chart-name <string>]
                                     [--version <string>] [-h]

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--helm

Helm URL.

--helm-chart-name

Helm Chart Name.

--version

Helm version.

--git-reference

This can be commit, tag, or branch. If omitted, will equal to HEAD

--git-repository-path

Directory path within the Git repository, and is only valid for applications sourced from Git.

--git-repository-url

URL to the repository (Git or Helm) that contains the application manifests.

Required named arguments¶

--display-name: Application display name.
--desc: Application description.

update¶

Update an application.

ngc fleet-command application update [--debug] [--desc <string>]
                                     [--display-name <string>]
                                     [--format_type <fmt>] [-h]
                                     <target>

Positional Arguments¶

<target>: Helm name.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--display-name

Application display name.

--desc

Application description.

component¶

Fleet Command Component Commands

ngc fleet-command component [--debug] [--format_type <fmt>] [-h]  ...

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

component¶

: Possible choices: list

Sub-commands¶

list¶

Print a list of available components.

ngc fleet-command component list [--debug] [--format_type <fmt>] --from-date
                                 <date> --to-date <date> [-h]

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

Required named arguments¶

--from-date: Start of date range. (Format: yyyy-MM-dd::HH:mm:ss)
--to-date: End of date range. (Format: yyyy-MM-dd::HH:mm:ss)

deployment¶

Fleet Command Deployment Commands

ngc fleet-command deployment [--debug] [--format_type <fmt>] [-h]  ...

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

deployment¶

: Possible choices: create, info, list, remove, update

Sub-commands¶

info¶

Show details for the specified deployment.

ngc fleet-command deployment info [--debug] [--format_type <fmt>] [-h]
                                  <target>

Positional Arguments¶

<target>: Deployment name.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

remove¶

Remove the specified deployment.

ngc fleet-command deployment remove [--debug] [--format_type <fmt>] [-h] [-y]
                                    <target>

Positional Arguments¶

<target>: Deployment name.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

-y, --yes

Automatically say yes to all interactive questions.

list¶

List deployment(s).

ngc fleet-command deployment list [--column <column>] [--debug]
                                  [--format_type <fmt>] [-h]
                                  [<target>]

Positional Arguments¶

<target>: Deployment(s) to list. This argument supports Unix glob style pattern matching. If no target deployment is given, all visible deployments will be listed.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--column

Specify output column as column[=header], header is optional, default is name[=Name]. Valid columns are name[=Name], app[="App Name"], locations[=Locations]. Use quotes with spaces. Multiple column arguments are allowed.

create¶

Create a new deployment.

ngc fleet-command deployment create [--allow-any-capability]
                                    [--allow-any-host-path]
                                    [--allow-device-access]
                                    [--allow-host-namespace]
                                    [--allow-host-path-pv]
                                    [--allow-privileged-containers]
                                    [--appconfig <appconfig_name>]
                                    --application <application_id> [--debug]
                                    [--format_type <fmt>] --location
                                    <location>
                                    [--target-namespace <target_namespace>]
                                    [-h] [-y]
                                    <target>

Positional Arguments¶

<target>: Deployment name.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--appconfig

application config. If none given, the DEFAULT will be used

--target-namespace

This is the Kubernetes namespace to be deployed into (if the app configuration does not override it).

--allow-device-access

Enable application access to all system devices for this deployment. (Applies to locations on version 1.0.0 or higher).Note, after deployment this option cannot be changed without recreating the deployment.

--allow-any-host-path

Enable application access to all of the file-system. (Applies to locations on version 1.8.5 or higher).Note, after deployment this option cannot be changed without recreating the deployment.

--allow-host-path-pv

Enable application access to persistent volumes on the system. (Applies to locations on version 1.8.5 or higher).Note, after deployment this option cannot be changed without recreating the deployment.

--allow-any-capability

Enable application pods to have any system capabilities on the system. (Applies to locations on version 1.8.5 or higher).Note, after deployment this option cannot be changed without recreating the deployment.

--allow-privileged-containers

Enable privileged containers on the system. (Applies to locations on version 1.8.5 or higher).Note, after deployment this option cannot be changed without recreating the deployment.

--allow-host-namespace

Enable application access to the system processes. (Applies to locations on version 1.8.5 or higher).Note, after deployment this option cannot be changed without recreating the deployment.

-y, --yes

Automatically say yes to all interactive questions.

Required named arguments¶

--location: location(s) to target. To specify multiple locations, use multiple --location arguments.
--application: Application Id

update¶

Update a deployment.

ngc fleet-command deployment update [--add-location <location_name>]
                                    [--appconfig <appconfig_name>]
                                    [--appconfig-clear]
                                    [--application <helm_name>] [--debug]
                                    [--format_type <fmt>]
                                    [--remove-location <location_name>] [-h]
                                    [-y]
                                    <target>

Positional Arguments¶

<target>: Deployment name.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--appconfig

Application config.

--appconfig-clear

Clear the appconfig. This will configure the deployment to use the DEFAULT appconfig.

--add-location

Location(s) to add to the deployment. To add multiple locations, use multiple --add-location arguments.

--remove-location

Location(s) to remove from the deployment. To remove multiple locations, use multiple --remove-location arguments.

-y, --yes

Automatically say yes to all interactive questions.

--application

Helm name.

settings¶

Fleet Command Settings Commands

ngc fleet-command settings [--debug] [--format_type <fmt>] [-h]  ...

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

settings¶

: Possible choices: current, set

Sub-commands¶

set¶

Update global settings.

ngc fleet-command settings set [--alert-critical-level <alert-critical-level>]
                               [--alert-critical-message <alert-critical-message>]
                               [--alert-key <alert-key>]
                               [--alert-warning-level <alert-warning-level>]
                               [--alert-warning-message <alert-warning-message>]
                               [--debug] [--disable-application-logs]
                               [--disable-deployment-security-overrides]
                               [--disable-full-system-logs]
                               [--disable-remote-application-access]
                               [--disable-remote-management]
                               [--enable-application-logs]
                               [--enable-deployment-security-overrides]
                               [--enable-full-system-logs]
                               [--enable-remote-application-access]
                               [--enable-remote-management]
                               [--format_type <fmt>]
                               [--remote-application-access-timeout <seconds>]
                               [--remote-console-max-idle-duration <seconds>]
                               [--remote-console-max-session-duration <seconds>]
                               [-h] [-y]

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--enable-remote-management

Enable remote management. This enables remote console, system reboot and monitoring.

--disable-remote-management

Disable remote management. This disables remote console, system reboot and monitoring.

--remote-console-max-session-duration

Set the remote console maximum session duration.

--remote-console-max-idle-duration

Set the remote console maximum idle duration.

--enable-remote-application-access

Enable remote application access.

--disable-remote-application-access

Enable remote application access.

--remote-application-access-timeout

Set the maximum duration of a remote application session.

--enable-application-logs

Enable application and deployment logging.

--disable-application-logs

Disable application and deployment logging.

--enable-full-system-logs

Enable full system and location logging.

--disable-full-system-logs

Disable full system and location logging. Only Fleet Command logging enabled.

--enable-deployment-security-overrides

Enable the use of security overrides when creating deployments.

--disable-deployment-security-overrides

Disable the use of security overrides when creating deployments.

--alert-key

Set the alert settings for particular key. Options: CPU,MEM,DISK

--alert-critical-level

Set the threshold for which warning messages should be logged into alerts

--alert-critical-message

Set the message for your report when critical level is reached

--alert-warning-level

Set the threshold for which warning messages should be logged into alerts

--alert-warning-message

Set the message for your alert when warning level is reached

-y, --yes

Automatically say yes to all interactive questions.

current¶

Display current global settings.

ngc fleet-command settings current [--debug] [--format_type <fmt>] [-h]

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

location¶

Fleet Command Location Commands

ngc fleet-command location [--debug] [--format_type <fmt>] [-h]  ...

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

location¶

: Possible choices: add-system, create, info, list, mig-disable, mig-enable, reboot-system, remove, reset-location, update, update-version

Sub-commands¶

info¶

Show details for a location or system.

ngc fleet-command location info [--debug] [--format_type <fmt>]
                                [--show-labels] [-h]
                                <location>[:<system>]

Positional Arguments¶

<location>[:<system>]: Location name.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--show-labels

Show all the kubernetes labels associated with the NodeOnly usable if system is specified.

remove¶

Remove a location or system.

ngc fleet-command location remove [--debug] [--format_type <fmt>] [-h] [-y]
                                  <target>

Positional Arguments¶

<target>: Location or system name. Format: <location name>[:<system name>]

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

-y, --yes

Automatically say yes to all interactive questions.

list¶

List location(s) or system(s).

ngc fleet-command location list [--column <column>] [--debug]
                                [--format_type <fmt>] [-h]
                                [<target>]

Positional Arguments¶

<target>: Filter the search by allowing glob-like patterns for location(s) or system(s). Format [location[:system]]. To target location(s) use "location_name". To target system(s) use "location_name:system_name". Both location_name and system_name support standard Unix shell-style wildcards like (?, [abc], [~a-z], etc.). Examples: "Location*" - list all locations with names matching "Location*". "location_a:" - list all systems at location_a. "location_b:austin" - list all systems at location_b matching "austin*".

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--column

Specify output column as column[=header]. The header is optional. The default is name[=Name] for both locations and systems. Valid location columns are name[=Name], status[=Status], updateStatus[=Update Status], description[=Description], address[=Address]. Valid system columns are name[=Name], status[=Status], role[=Config], ipAddress[=Local IP]. Use quotes with spaces. Multiple column arguments are allowed.

create¶

Create a new location.

ngc fleet-command location create --address <string>
                                  [--allow-high-availability] [--debug] --desc
                                  <string> [--enable-argo-cd]
                                  [--format_type <fmt>]
                                  [--require-signed-containers] --version
                                  <semver> [-h]
                                  <target>

Positional Arguments¶

<target>: Location name.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--allow-high-availability

Allows for the first three systems added to the location to automatically be set as controller-workers.Cannot be changed once created.

--require-signed-containers

Deployments at this location require signed containers.

--enable-argo-cd

Enable locations to have applications that use ArgoCD

Required named arguments¶

--desc: Location description.
--address: Location address.
--version: NodeStack version.

add-system¶

Add a new system to a location.

ngc fleet-command location add-system [--debug] --desc <string>
                                      [--device-type <string>]
                                      [--format_type <fmt>] [-h]
                                      <target>

Positional Arguments¶

<target>: System name. Format: <location name>:<system name>

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--device-type

Device Type

Required named arguments¶

--desc: System description.

update-version¶

Update version for a location.

ngc fleet-command location update-version [--debug] [--format_type <fmt>]
                                          --version <semver> [-h] [-y]
                                          <target>

Positional Arguments¶

<target>: Location name.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

-y, --yes

Automatically say yes to all interactive questions.

Required named arguments¶

--version: Version.

update¶

Update a location or system.

ngc fleet-command location update [--address <string>] [--debug]
                                  [--desc <string>] [--format_type <fmt>]
                                  [--require-signed-containers] [-h]
                                  <target>

Positional Arguments¶

<target>: Location or system name. Format: <location name>[:<system name>]

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--desc

Location or system description.

--address

Location address.

--require-signed-containers

New deployments at this location require signed containers.Previously deployed applications may include unverified containers.

reset-location¶

Initiate reset of location. Action will recreate the Kubernetes cluster at the location. Expect application downtime while it automatically redeploys to the edge.

ngc fleet-command location reset-location [--debug] [--format_type <fmt>] [-h]
                                          [-y]
                                          <target>

Positional Arguments¶

<target>: System name. Format: <location name>:<system name>

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

-y, --yes

Automatically say yes to all interactive questions.

reboot-system¶

Initiate reboot of the specified system. Remote management must be enabled to use this command.

ngc fleet-command location reboot-system [--debug] [--format_type <fmt>] [-h]
                                         [-y]
                                         <target>

Positional Arguments¶

<target>: System name. Format: <location name>:<system name>

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

-y, --yes

Automatically say yes to all interactive questions.

mig-enable¶

Configure Multi-Instance GPU (MIG). MIG allows supported GPUs to be partitioned and used across multiple applications. Warning, this command should only be executed when all deployments using the GPU have been terminated and the GPU is idle. If this command is executed on a GPU with a running deployment, the changes will temporarily disrupt applications and may cause applications to stop running if a selected configuration is not compatible.

ngc fleet-command location mig-enable [--debug] [--format_type <fmt>] [-h]
                                      [-y]
                                      <target> <gpuId>:<config>
                                      [<gpuId>:<config> ...]

Positional Arguments¶

<target>: System name. Format: <location name>:<system name>
<gpuId>:<config>: Space-separated list of GPU IDs and Configurations. Format: <gpuID>:<config>

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

-y, --yes

Automatically say yes to all interactive questions.

mig-disable¶

Disable Multi-Instance GPU(s) on a system.

ngc fleet-command location mig-disable [--debug] [--format_type <fmt>] [-h]
                                       [-y]
                                       <target> <gpuId> [<gpuId> ...]

Positional Arguments¶

<target>: System name. Format: <location name>:<system name>
<gpuId>: Space-separated list of GPU IDs

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

-y, --yes

Automatically say yes to all interactive questions.

log¶

Fleet Command Log Commands

ngc fleet-command log [--debug] [--format_type <fmt>] [-h]  ...

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

log¶

: Possible choices: download

Sub-commands¶

download¶

Print log entries over a period of time into a file in the CSV format. Limited to 100,000 entries

ngc fleet-command log download [--additional-query <query>]
                               [--component <component>] [--debug]
                               [--deployment <deployment>]
                               [--format_type <fmt>] [--from-date <date>]
                               [--location <location>] --name <name>
                               [--range <seconds>] [--system <system>]
                               [--to-date <date>] [-h]

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--location

Location name. Multiple locations can be provided. Default is '*' for all locations.

--system

System name.

--deployment

Deployment name.

--component

Component name.

--additional-query

Additional query.

--from-date

Start of date range. (Format: yyyy-MM-dd::HH:mm:ss)

--to-date

End of date range. (Format: yyyy-MM-dd::HH:mm:ss)

--range

Download the most recent logs starting from <range> seconds ago

Required named arguments¶

--name: The name output file.

metric¶

Fleet Command Metric Commands

ngc fleet-command metric [--debug] [--format_type <fmt>] [-h]  ...

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

metric¶

: Possible choices: buckets, list, query, summary

Sub-commands¶

buckets¶

Get the org wide list of buckets

ngc fleet-command metric buckets [--debug] [--format_type <fmt>] [-h]

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

list¶

List all metrics in a bucket

ngc fleet-command metric list --bucket <bucket> [--debug]
                              [--format_type <fmt>] [-h]

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

Required named arguments¶

--bucket: Bucket Name

summary¶

Provides a summary of a given metric

ngc fleet-command metric summary --bucket <bucket> [--debug] [--field <field>]
                                 [--format_type <fmt>] --from-date <date>
                                 [--location <location>] --to-date <date> [-h]
                                 <metric>

Positional Arguments¶

<metric>: Metric Name

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--location

Location name.

--field

Field Name

Required named arguments¶

--bucket: Bucket Name
--from-date: Start of date range. (Format: yyyy-MM-dd::HH:mm:ss)
--to-date: End of date range. (Format: yyyy-MM-dd::HH:mm:ss)

query¶

Raw InfluxDB query interface with Flux, returns a JSON object

ngc fleet-command metric query [--debug] [--format_type <fmt>] [-h] <query>

Positional Arguments¶

<query>: Raw flux query interface

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

remote¶

Fleet Command Remote Commands

ngc fleet-command remote [--debug] [--format_type <fmt>] [-h]  ...

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

remote¶

: Possible choices: app-access, console

Sub-commands¶

console¶

Uses ssh to establish a console session with the specified location.

ngc fleet-command remote console [--debug] [--end-session]
                                 [--format_type <fmt>] [-h]
                                 <location>:<system>

Positional Arguments¶

<location>:<system>: Location and system name.

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--end-session

Terminates the existing session

app-access¶

Proxies a Web-based application services running on edge systems to the localhost

ngc fleet-command remote app-access [--allow-external-traffic] [--debug]
                                    --deployment <deployment-name>
                                    [--end-session] [--format_type <fmt>]
                                    [--local-port <port-number>] [-h] [-y]
                                    <location>:<port>

Positional Arguments¶

<location>:<port>: Location and port which service is currently running deployment

Named Arguments¶

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--end-session

Terminates the existing session

--local-port

Will open locally on this port if able to, otherwise will fail

--allow-external-traffic

Forwards traffic to all interfaces, allowing all traffic to access this application

-y, --yes

Automatically say yes to all interactive questions.

Required named arguments¶

--deployment

Examples¶

How to create a location¶

$ ngc fleet-command location create test-location --address "Austin TX" --desc "Create a test location" --version 0.4.30
--------------------------------------------------
  Location Information
      Name: test-location
      Address: Austin TX
      Description: Create a test location
      Status: NONE
      Version Last Updated:
      Version: 0.4.30
      Update Available:
      Update Status: UNKNOWN
      Logs: https://egxqatest.graylog.api.stg.ngc.nvidia.com/search?q=location%3Atest-location+AND+component%3A%2A&rangetype=relative&relative=0
      Systems:
--------------------------------------------------

How to add a system¶

$ ngc fleet-command location add-system test-location:test-sys-1 --desc "create a test system"
--------------------------------------------------
  Location Information
    Name: test-location
    Address: Austin TX
    Description: Create a test location
    Status: NONE
    Version Last Updated: 02/01/2021
    Version: 0.4.30
    Update Available:
    Update Status: UNKNOWN
    Logs: https://egxqatest.graylog.api.stg.ngc.nvidia.com/search?q=location%3Atest-location+AND+component%3A%2A&rangetype=relative&relative=0
    Message: System test-sys-1 successfully added, use activation code x6o0-s7u7-t6k2 to pair the system. The activation code will expire in 11:59:20.
    Systems:
        Name: test-sys-1
        Status: CONNECTING
        Marked For Delete: False
        Config:
        Local IP:
        Description: create a test system
        Logs: https://egxqatest.graylog.api.stg.ngc.nvidia.com/search?q=location%3Atest-location+AND+source%3Atest-sys-1.egx.nvidia.com+AND+component%3A%2A&rangetype=relative&relative=0
--------------------------------------------------

How to create an application¶

$ ngc fleet-command application create test-helm-application --desc "Add a test application" --display-name "Test Helm Application" --helm https://helm.ngc.nvidia.com/testapp --version 1.0.0
 --------------------------------------------------
   Application Information
     Display Name: Test Helm Application
     Helm Name: test-helm-application
     Create Time: 2021-02-01 18:02:33 UTC
     Description: Add a test application
     Helm Repo: https://helm.ngc.nvidia.com/testapp
     Helm Version: 1.0.0
--------------------------------------------------

How to create an application configuration¶

$ ngc fleet-command appconfig create test-appconfig --filename test-appconfig.yaml
--------------------------------------------------
  AppConfig Information
    Name: test-appconfig
    Create Time: 2021-02-01 18:04:39 UTC
    Contents:
        key: value
--------------------------------------------------

How to create a deployment¶

$ ngc fleet-command deployment create test-deployment --application test-application --location test-location
Deployment will initiate immediately and cannot be undone.  Are you sure you would like to continue? [y/n]y
--------------------------------------------------
  Deployment Information
    Name: test-deployment
    Application: test-application
    Appconfig:
    Logs: https://egxqatest.graylog.api.stg.ngc.nvidia.com/search?q=deploymentname%3test-deployment&rangetype=relative&relative=0
    Issue: One or more locations are offline. Deployed applications may stop running and no new deployments can be made to those locations until they are online.
    Locations:
        Name: test-system
        Location Status: OFFLINE_MODE
        Deployment Status: DEPLOYING
        Description: Create a test location
        Address: test-application
        Logs: https://egxqatest.graylog.api.stg.ngc.nvidia.com/search?q=location%3test-location+AND+deploymentname%3Aus-north-100&rangetype=relative&relative=0
--------------------------------------------------

How to update a MiG configuration¶

Get GPU MiG configurations

$ ngc fleet-command location info test-location:test-system
-----------------------------------------------------------------
 System Information
   Name: test-location
   Status: READY
   Marked For Delete: False
   Config: controller-worker
   Local IP: 172.16.0.117
   Description: test-location
   Advanced Networking Details
     Default Gateway: 172.16.0.1
     Default Interface: ens5f0
     Host Name: test-location.egx.nvidia.com
     HTTP Proxy:
     HTTPS Proxy:
     No Proxy:
     Interface 1
       Name: ens6f0
       IP Addresses: fe80::bace:f6ff:fedf:e8b4/64

     Interface 2
       Name: ens6f1
       IP Addresses: fe80::bace:f6ff:fedf:e8b5/64

     Interface 3
       Name: ens5f0
       IP Addresses: 172.16.0.117/24, fe80::ac0:ebff:fe32:5c8a/64

     Interface 4
       Name: ens5f1
       IP Addresses: fe80::ac0:ebff:fe32:5c8b/64

   GPU Details
     Application Compatibility: Yes
     GPU 0
       Description: NVIDIA A30-24GB
       MIG Status: ENABLED
     MIG Profile: 4 MIGs of 1c.6gb
       Available MIG Profiles: 2c.12gb, 1c.6gb

-----------------------------------------------------------------

$ ngc fleet-command location mig-enable test-location:test-system 'GPU 0:1c.6gb' -y
  Warning, changes will temporarily disrupt any running applications on test-location.
  Successfully sent request to enable MIG on test-location, GPUs: GPU 0:1c.6gb.

How to delete an appconfig/deployment¶

$ ngc fleet-command appconfig remove 028567238d52b00e76810cd2d3bac6bf -y
appconfig '028567238d52b00e76810cd2d3bac6bf' successfully removed.

$ ngc fleet-command deployment remove temp-deployment -y
Deployment 'temp-deployment' successfully removed.

How to create a custom deployment with appconfig¶

$ ngc fleet-command deployment create --location test-location --application t2cf1b295-a4aa-4024-ac8f-7c928b8b80c7l --appconfig 2a978ac8e17d6220719494a29d813673 test-deployment-name2
Deployment will initiate immediately and cannot be undone.  Are you sure you would like to continue? [y/n]y
------------------------------------------------------
 Deployment Information
   Name: test-deployment-name2
   Application: t2cf1b295-a4aa-4024-ac8f-7c928b8b80c7l
   Appconfig: 2a978ac8e17d6220719494a29d813673
   Application Access to All System Devices: Disabled
   Allow any path to be used by host path: Disabled
   Allow host path persistent volume: Disabled
   Allow any capability: Disabled
   Allow privileged containers: Disabled
   Allow host namespace: Disabled
 Locations
 Name: test-location
     Location Status: ONLINE
     Deployment Status: DEPLOYING
     Description: HQ Building
     Address: San Tomas Expwy
------------------------------------------------------

How to use remote console¶

$ ngc fleet-command remote console a-a-a-apartha-gpuoploc:gpuopnode
Console request created
Console not ready, Retry 1/10
Console not ready, Retry 2/10
Console ready; setting up connection...
Connecting to console... use Ctrl-C/Ctrl-D to exit
Warning: Permanently added '[localhost]:52277' (ED25519) to the list of known hosts.
Authorized uses only. All activity may be monitored and reported.
Welcome to Ubuntu 20.04.5 LTS (GNU/Linux 5.4.0-125-generic x86_64)

 * Documentation:  https://help.ubuntu.com
 * Management:     https://landscape.canonical.com
 * Support:        https://ubuntu.com/advantage

The programs included with the Ubuntu system are free software;
the exact distribution terms for each program are described in the
individual files in /usr/share/doc/*/copyright.

Ubuntu comes with ABSOLUTELY NO WARRANTY, to the extent permitted by
applicable law.


The programs included with the Ubuntu system are free software;
the exact distribution terms for each program are described in the
individual files in /usr/share/doc/*/copyright.

Ubuntu comes with ABSOLUTELY NO WARRANTY, to the extent permitted by
applicable law.

Last login: Wed Oct 12 13:18:05 2022 from 127.0.0.1
Could not chdir to home directory /home/rcproxy: No such file or directory
rcuser@cpu0871:~$ lsb_release -a
No LSB modules are available.
Distributor ID:     Ubuntu
Description:        Ubuntu 20.04.5 LTS
Release:    20.04
Codename:   focal