org¶

Org Commands

usage: ngc org [--debug] [--format_type <fmt>] [-h] {subscription} ...

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

org¶

{subscription}: Possible choices: add-team, add-user, delete-invitation, info, list, list-users, remove-team, remove-user, subscription, update-team, update-user

Sub-commands¶

subscription¶

Product Subscription Commands

ngc org subscription [--debug] [--format_type <fmt>] [-h] {info,list} ...

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

subscription¶

{info,list}: Possible choices: add, info, list, remove, renew

Sub-commands¶

add¶

Add a subscription.

ngc org subscription add [--debug] [--format_type <fmt>] [-h] -product
                         [<product>] -quantity [<quantity>] -rate-plan
                         [<rate_plan>] [-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

-y, --yes

Automatically say yes to all interactive questions.

Required named arguments¶

-product: Product name.
-rate-plan: Rate plan SKU.
-quantity: Number of subscriptions.

info¶

Get subscription details.

ngc org subscription info [--debug] [--format_type <fmt>] [-h]
                          [<subscription_id>]

Positional Arguments¶

<subscription_id>: Subscription 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

list¶

List all subscriptions.

ngc org subscription list [--column <column>] [--debug] [--format_type <fmt>]
                          [--status <status>] [-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

--status

Possible choices: ACTIVE, CANCELLED, EXPIRED, GTS_BAD_REQUEST, GTS_BLOCKED, PENDING

Filter by status. Choices are: ACTIVE, EXPIRED, PENDING, CANCELLED, GTS_BLOCKED, GTS_BAD_REQUEST

--column

Specify output column as column[=header], header is optional, default is subscriptionId[=Id]. Valid columns are displayName[=Product], status[=Status], autoRenew[="Auto Renew"], expirationDate[="Expiration Date"]. Use quotes with spaces. Multiple column arguments are allowed.

renew¶

Renew subscription.

ngc org subscription renew [--debug] [--format_type <fmt>] [-h] [-y]
                           [<subscription_id>]

Positional Arguments¶

<subscription_id>: Subscription 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

-y, --yes

Automatically say yes to all interactive questions.

remove¶

Remove subscription.

ngc org subscription remove [--debug] [--format_type <fmt>] [-h] [-y]
                            [<subscription_id>]

Positional Arguments¶

<subscription_id>: Subscription 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

-y, --yes

Automatically say yes to all interactive questions.

list¶

List all accessible organizations.

ngc org 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], header is optional, default is id[=Id]. Valid columns are name[=Name], description[=Description], type[=Type]. Use quotes with spaces. Multiple column arguments are allowed.

info¶

Get organization details.

ngc org info [--debug] [--format_type <fmt>] [-h] <org_name>

Positional Arguments¶

<org_name>: Organization 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

add-user¶

(For administrators only) Add (create) a user to the current organization.

ngc org add-user [--debug] [--format_type <fmt>] --role <r> [-h]
                 <email> <name>

Positional Arguments¶

<email>: User Email
<name>: User 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¶

--role: Specify the user role. Options: BASE_COMMAND_ADMIN, BASE_COMMAND_USER, BASE_COMMAND_VIEWER, FLEET_COMMAND_ADMIN, FLEET_COMMAND_OPERATOR, FLEET_COMMAND_VIEWER, FORGE_PROVIDER_ADMIN, FORGE_TENANT_ADMIN, NVIDIA_AI_ENTERPRISE_VIEWER, OMNIVERSE_ADMIN, OMNIVERSE_READ, OMNIVERSE_USER, REGISTRY_ADMIN, REGISTRY_READ, REGISTRY_USER, USER_ADMIN. To specify more than one role, use multiple --role arguments.

update-user¶

(For administrators only) Update a user's roles in the current organization.

ngc org update-user [--add-role <add_role>] [--debug] [--format_type <fmt>]
                    [--remove-role <remove_role>] [--role <role>] [-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

--role

Specify the user role. Options: BASE_COMMAND_ADMIN, BASE_COMMAND_USER, BASE_COMMAND_VIEWER, FLEET_COMMAND_ADMIN, FLEET_COMMAND_OPERATOR, FLEET_COMMAND_VIEWER, FORGE_PROVIDER_ADMIN, FORGE_TENANT_ADMIN, NVIDIA_AI_ENTERPRISE_VIEWER, OMNIVERSE_ADMIN, OMNIVERSE_READ, OMNIVERSE_USER, REGISTRY_ADMIN, REGISTRY_READ, REGISTRY_USER, USER_ADMIN. To specify more than one role, use multiple --role arguments.

--add-role

Specify the user role to assign. Options: [BASE_COMMAND_ADMIN, BASE_COMMAND_USER, BASE_COMMAND_VIEWER, FLEET_COMMAND_ADMIN, FLEET_COMMAND_OPERATOR, FLEET_COMMAND_VIEWER, FORGE_PROVIDER_ADMIN, FORGE_TENANT_ADMIN, NVIDIA_AI_ENTERPRISE_VIEWER, OMNIVERSE_ADMIN, OMNIVERSE_READ, OMNIVERSE_USER, REGISTRY_ADMIN, REGISTRY_READ, REGISTRY_USER, USER_ADMIN]. To specify more than one role, use multiple --add-role arguments.

--remove-role

Specify the user role to remove. Options: [BASE_COMMAND_ADMIN, BASE_COMMAND_USER, BASE_COMMAND_VIEWER, FLEET_COMMAND_ADMIN, FLEET_COMMAND_OPERATOR, FLEET_COMMAND_VIEWER, FORGE_PROVIDER_ADMIN, FORGE_TENANT_ADMIN, NVIDIA_AI_ENTERPRISE_VIEWER, OMNIVERSE_ADMIN, OMNIVERSE_READ, OMNIVERSE_USER, REGISTRY_ADMIN, REGISTRY_READ, REGISTRY_USER, USER_ADMIN]. To specify more than one role, use multiple --remove-role arguments.

remove-user¶

(For administrators only) Remove a user from the current organization.

ngc org remove-user [--debug] [--format_type <fmt>] [-h] [-y] <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

-y, --yes

Automatically say yes to all interactive questions.

delete-invitation¶

(For administrators only) Delete a user invitation meant for the current organization.

ngc org delete-invitation [--debug] [--format_type <fmt>] [-h] [-y]
                          <invitation_id>

Positional Arguments¶

<invitation_id>: Invitation 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

-y, --yes

Automatically say yes to all interactive questions.

list-users¶

(For administrators only) List all users in the current organization.

ngc org list-users [--column <column>] [--debug] [--email <email>]
                   [--format_type <fmt>] [--invited] [--joined] [-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

--joined

Only list users that have joined.

--invited

Only list invited users.

--column

Specify output column as column[=header], header is optional, default is id[=Id]. Valid columns are name[=Name], email[=Email], roles[=Roles], created[="Created Date"], type[="Invitation Type"], firstLoginDate[="First Login Date"], lastLoginDate[="Last Activity"], idpType[="Sign In Method"]. Use quotes with spaces. Multiple column arguments are allowed.

--email

Filter users by email.

add-team¶

(For administrators only) Add (create) a team in the current organization.

ngc org add-team [--debug] [--format_type <fmt>] [-h] <name> <description>

Positional Arguments¶

<name>: Team Name
<description>: Team Description

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-team¶

(For administrators only) Update the information for a team in your organization.

ngc org update-team [--debug] [--format_type <fmt>] [-h] <name> <description>

Positional Arguments¶

<name>: Team Name
<description>: Team Description

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-team¶

(For administrators only) Removes a team from a given organization.

ngc org remove-team [--debug] [--format_type <fmt>] [-h] [-y] <team name>

Positional Arguments¶

<team name>: Team 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.

Examples¶

How to list orgs?¶

$ ngc org list

+------+---------+-------------+-------+
| Id   | Name    | Description | Type  |
+------+---------+-------------+-------+
| 9441 | nvexmpl | nvexmpl     | CLOUD |
| 91   | robot   | robot       | CLOUD |
+------+---------+-------------+-------+

How to list orgs using column arguments?¶

$ ngc org list --column name --column type='Org Type'

+------+---------+----------+
| Id   | Name    | Org Type |
+------+---------+----------+
| 9441 | nvexmpl | CLOUD    |
| 91   | robot   | CLOUD    |
+------+---------+----------+

How to get org details?¶

$ ngc org info robot

----------------------------------------------------
 Org Information
  Id: 1
  Name: nvidia
  Description: nvidia
  Type: CLOUD
----------------------------------------------------

How to list users in current org?¶

$ ngc org list-users

+------+---------+-------------------+---------------------+--------------------------+
| Id   | Name    | Email             | Roles               | Created Date             |
+------+---------+-------------------+---------------------+--------------------------+
| 0001 | Admin1  | admin1@nvidia.com | BASE_COMMAND_ADMIN  | 2018-01-01T00:01:00.000Z |
| 0004 | User1   | user1@nvidia.com  | BASE_COMMAND_USER   | 2018-01-04T00:03:00.000Z |
| 0002 | Admin2  | admin2@nvidia.com | BASE_COMMAND_ADMIN  | 2018-01-02T00:12:00.000Z |
| 0003 | Viewer1 | admin3@nvidia.com | BASE_COMMAND_VIEWER | 2018-01-03T00:07:00.000Z |
+------+---------+-------------------+---------------------+--------------------------+

How to list users in current org using column arguments?¶

$ ngc org list-users --column name --column roles

+------+---------+---------------------+
| Id   | Name    | Roles               |
+------+---------+---------------------+
| 0001 | Admin1  | BASE_COMMAND_ADMIN  |
| 0004 | User1   | BASE_COMMAND_USER   |
| 0002 | Admin2  | BASE_COMMAND_ADMIN  |
| 0003 | Viewer1 | BASE_COMMAND_VIEWER |
+------+---------+---------------------+

How to add user to an org?¶

$ ngc org add-user foobar@nvidia.com FooBar --role BASE_COMMAND_USER

User foobar@nvidia.com has been added to org nvidia as {'BASE_COMMAND_USER'}.
+---------+--------+-------------------+----------------------------+
| User Id | Name   | Email             | Org [Roles]                |
+---------+--------+-------------------+----------------------------+
| 11026   | FooBar | foobar@nvidia.com | nvidia [BASE_COMMAND_USER] |
+---------+--------+-------------------+----------------------------+

How to update user role?¶

$ ngc org update-user foobar@nvidia.com -r BASE_COMMAND_ADMIN

User foobar@nvidia.com information updated.
+---------+---------+-----------------------+-----------------------------------+
| User Id | Name    | Email                 | Org [Roles]                       |
+---------+---------+-----------------------+-----------------------------------+
| 481     | FooBar  | foobar@nvidia.com     | b0xlotzw8zo9 [BASE_COMMAND_ADMIN] |
+---------+---------+-----------------------+-----------------------------------+

$ ngc org update-user foobar@nvidia.com -r BASE_COMMAND_USER

User foobar@nvidia.com information updated.
+---------+---------+-----------------------+----------------------------------+
| User Id | Name    | Email                 | Org [Roles]                      |
+---------+---------+-----------------------+----------------------------------+
| 481     | FooBar  | foobar@nvidia.com     | b0xlotzw8zo9 [BASE_COMMAND_USER] |
+---------+---------+-----------------------+----------------------------------+

How to remove user from an org?¶

$ ngc org remove-user foobar@nvidia.com

User: foobar@nvidia.com deleted from org: b0xlotzw8zo9.

How to create team inside an org?¶

$ ngc org add-team cosmos "Cosmos team"

Team created.
----------------------------------------------------
  Team Information
    Id: 161
    Name: cosmos
    Description: Cosmos team
    Deleted: False
----------------------------------------------------

How to update team description inside an org?¶

$ ngc org update-team cosmos "Updated description"

Team cosmos information updated.
----------------------------------------------------
  Team Information
    Id: 161
    Name: cosmos
    Description: Updated description
    Deleted: False
----------------------------------------------------

How to remove team from an org?¶

$ ngc org remove-team cosmos "Cosmos team"

Team: cosmos removed from org: b0xlotzw8zo9.