user¶
User Commands
usage: ngc user [--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
user¶
Possible choices: info, secret, storage, update, who
Sub-commands¶
secret¶
Secret Commands
ngc user secret [--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
secret¶
Possible choices: create, delete, info, list, update
Sub-commands¶
create¶
Create a new secret
ngc user secret create [--debug] --desc <description> [--format_type <fmt>]
--pair <key:value> [-h]
<secret-name>
Positional Arguments¶
- <secret-name>
Name of Secret
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¶
- --desc
Description of a secret
- --pair
A key-value pair to be added to the secret. A key name must be between 1-63 characters and contain letters, numbers or ./-_ May be used multiple times in the same command.
list¶
List available secrets for this user
ngc user secret list [--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 details on a specified secret, keys redacted unless specified otherwise
ngc user secret info [--debug] [--format_type <fmt>] [--key <key>] [-h]
<secret-name>
Positional Arguments¶
- <secret-name>
Name of Secret
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
- --key
Filter all keys except ones provided by this flag, can be used multiple times.
delete¶
Delete all secrets or a specific secret or key-value pairs from a secret
ngc user secret delete [--debug] [--format_type <fmt>] [--key <key>]
[--secret <secret-name>] [-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
- --secret
Specify the name of the secret to delete.
- -y, --yes
Automatically say yes to all interactive questions.
- --key
Delete a key-value pair from a secret rather than the secret itself. May be used multiple time to delete more than one key-value pair. Required Parameter of Secret.
update¶
Update a secret description, key-value pairs.
ngc user secret update [--debug] [--desc <description>] [--disable] [--enable]
[--format_type <fmt>] [--pair <key:value>] [-h]
secret
Positional Arguments¶
- secret
Update a secret description, key-value pairs.
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
Description of a secret
- --pair
A key-value pair to be added to the secret. A key name must be between 1-63 characters and contain letters, numbers or ./-_ May be used multiple times in the same command.
- --enable
Enable a secret
- --disable
Disable a secret
info¶
Get user details by user id.
ngc user info [--debug] [--format_type <fmt>] [-h] <id>
Positional Arguments¶
- <id>
User ID
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
who¶
Show the current authorized NGC CLI user.
ngc user who [--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
storage¶
Get user storage. If ACE is set it will be used to filter storage.
ngc user storage [--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
update¶
Update current user information.
ngc user update [--debug] [--format_type <fmt>] [-h] [-n <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
- -n, --name
Update to this username.
Examples¶
How to show current user info?¶
$ ngc user who
+---------+--------+-------------+---------------------+---------------------+------------+
| User Id | Name | Email | Org | Teams | Created |
| | | | [Roles] | [Roles] | Date |
+---------+--------+-------------+---------------------+---------------------+------------+
| 50923 | ngccli | ngcexample | robot | robot-team | 2019-04-16 |
| | | @nvidia.com | [BASE_COMMAND_USER] | [BASE_COMMAND_USER] | 18:31:50 |
| | | | | | UTC |
+---------+--------+-------------+---------------------+---------------------+------------+
How to get user info by email?¶
$ ngc user info foobar@nvidia.com
+---------+--------+-------------------+----------------------+----------------------+-------------------------+
| User Id | Name | Email | Org [Roles] | Teams [Roles] | Created Date |
+---------+--------+-------------------+----------------------+----------------------+-------------------------+
| 481 | FooBar | foobar@nvidia.com | b0xlotzw8zo9 | cosmos | 2018-01-01 00:00:00 UTC |
| | | | [BASE_COMMAND_ADMIN] | [BASE_COMMAND_ADMIN] | |
+---------+--------+-------------------+----------------------+----------------------+-------------------------+
How to update current user's name?¶
$ ngc user update -n "New Name"
Current user's information updated.
+---------+----------+-----------------------+
| User Id | Name | Email |
+---------+----------+-----------------------+
| 481 | New Name | foobar@nvidia.com |
+---------+----------+-----------------------+
How to list user storage?¶
$ ngc user storage
+----------+-------------------------------------------------------+----------+----------+--------+-----------+
| ACE | Usage | Datasets | Results | Used | Available |
+----------+-------------------------------------------------------+----------+----------+--------+-----------+
| ace_name | ################--------------------------------- 33% | 1 @ 5.99 | 5 @ 9.12 | 3.3 GB | 6.7 GB |
| | | KB | KB | | |
+----------+-------------------------------------------------------+----------+----------+--------+-----------+