team

Team Commands

usage: ngc team [--debug] [--format_type <fmt>] [--org <name>] [--team <name>]
                [-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

--org

Specify the organization name. Use "--org no-org" to override other sources and specify no org (no-org cannot be used if API key is set). Default: current configuration

--team

Specify the team name. Use "--team no-team" to override other sources and specify no team. Default: current configuration

team

Possible choices: add-user, delete-invitation, info, list, list-users, remove-user, update-user

Sub-commands

list

List all accessible teams.

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

--org

Specify the organization name. Use "--org no-org" to override other sources and specify no org (no-org cannot be used if API key is set). Default: current configuration

--team

Specify the team name. Use "--team no-team" to override other sources and specify no team. Default: current configuration

--column

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

info

Get team details.

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

Positional Arguments

<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

--org

Specify the organization name. Use "--org no-org" to override other sources and specify no org (no-org cannot be used if API key is set). Default: current configuration

--team

Specify the team name. Use "--team no-team" to override other sources and specify no team. Default: current configuration

add-user

(For administrators only) Invite a new user to the current team by email, or add an existing org user to the current team by user ID. Inviting by email fails if the user already belongs to the org; use their user ID, 'ngc org add-user <email> --team <name>', or 'ngc team update-user <id> --add-role' instead.

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

Positional Arguments

<email|id>

User Email or 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

--org

Specify the organization name. Use "--org no-org" to override other sources and specify no org (no-org cannot be used if API key is set). Default: current configuration

--team

Specify the team name. Use "--team no-team" to override other sources and specify no team. Default: current configuration

--name

[DEPRECATED] This parameter is not used and will be ignored.

--org-role

(For org administrators only) Specify the user role in the org, required to add a new user in the org. Updates user roles in the org if the user exists in the org. Options: [FLEET_COMMAND_ADMIN, FLEET_COMMAND_OPERATOR, FLEET_COMMAND_VIEWER, NVIDIA_AI_ENTERPRISE_VIEWER, OMNIVERSE_ADMIN, OMNIVERSE_READ, OMNIVERSE_USER, ORG_OWNER, REGISTRY_ADMIN, REGISTRY_READ, REGISTRY_USER, USER_ADMIN]. To specify more than one org role, use multiple --org-role arguments.

Required named arguments

--role

Specify the user role. Options: [FLEET_COMMAND_ADMIN, FLEET_COMMAND_OPERATOR, FLEET_COMMAND_VIEWER, NVIDIA_AI_ENTERPRISE_VIEWER, OMNIVERSE_ADMIN, OMNIVERSE_READ, OMNIVERSE_USER, ORG_OWNER, 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 team. Adding a role also adds an existing org user to the team if they are not a member yet.

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

--org

Specify the organization name. Use "--org no-org" to override other sources and specify no org (no-org cannot be used if API key is set). Default: current configuration

--team

Specify the team name. Use "--team no-team" to override other sources and specify no team. Default: current configuration

--role

Replace all existing user roles with the specified role(s). This will remove any roles not specified. Options: [FLEET_COMMAND_ADMIN, FLEET_COMMAND_OPERATOR, FLEET_COMMAND_VIEWER, NVIDIA_AI_ENTERPRISE_VIEWER, OMNIVERSE_ADMIN, OMNIVERSE_READ, OMNIVERSE_USER, ORG_OWNER, 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: [FLEET_COMMAND_ADMIN, FLEET_COMMAND_OPERATOR, FLEET_COMMAND_VIEWER, NVIDIA_AI_ENTERPRISE_VIEWER, OMNIVERSE_ADMIN, OMNIVERSE_READ, OMNIVERSE_USER, ORG_OWNER, 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: [FLEET_COMMAND_ADMIN, FLEET_COMMAND_OPERATOR, FLEET_COMMAND_VIEWER, NVIDIA_AI_ENTERPRISE_VIEWER, OMNIVERSE_ADMIN, OMNIVERSE_READ, OMNIVERSE_USER, ORG_OWNER, 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 team.

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

--org

Specify the organization name. Use "--org no-org" to override other sources and specify no org (no-org cannot be used if API key is set). Default: current configuration

--team

Specify the team name. Use "--team no-team" to override other sources and specify no team. Default: current configuration

-y, --yes

Automatically say yes to all interactive questions.

delete-invitation

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

ngc team delete-invitation [--debug] [--format_type <fmt>] [--org <name>]
                           [--team <name>] [-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

--org

Specify the organization name. Use "--org no-org" to override other sources and specify no org (no-org cannot be used if API key is set). Default: current configuration

--team

Specify the team name. Use "--team no-team" to override other sources and specify no team. Default: current configuration

-y, --yes

Automatically say yes to all interactive questions.

list-users

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

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

--org

Specify the organization name. Use "--org no-org" to override other sources and specify no org (no-org cannot be used if API key is set). Default: current configuration

--team

Specify the team name. Use "--team no-team" to override other sources and specify no team. Default: current configuration

--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.

Examples

How to list teams?

$ ngc team list

+-----+------------+----------------------+
| Id  | Name       | Description          |
+-----+------------+----------------------+
| 393 | robot-team | Team for Integration |
|     |            | tests                |
+-----+------------+----------------------+

How to list teams using column arguments?

$ ngc team list --column name

+-----+------------+
| Id  | Name       |
+-----+------------+
| 393 | robot-team |
+-----+------------+

How to get team details?

$ ngc team info cosmos

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

How to list users in team?

$ ngc team list-users --team cosmos

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

How to list users in team using column arguments?

$ ngc team list-users --team cosmos --column name --column roles

+------+---------+---------------------+
| Id   | Name    | Roles               |
+------+---------+---------------------+
| 0001 | Admin1  | REGISTRY_ADMIN |
| 0004 | User1   | REGISTRY_USER  |
| 0002 | Admin2  | REGISTRY_ADMIN |
| 0003 | Viewer1 | REGISTRY_READ  |
+------+---------+---------------------+

How to add user to an team?

$ ngc team add-user foobar@nvidia.com --team cosmos --role REGISTRY_USER

User: foobar@nvidia.com added to team: cosmos as {'REGISTRY_USER'}.

How to update user role?

$ ngc team update-user foobar@nvidia.com REGISTRY_ADMIN --team cosmos

User foobar@nvidia.com information updated.
+---------+--------+-------------------+--------------+-----------------------------+-------------------------+
| User Id | Name   | Email             | Org          | Teams [Roles]               | Created Date            |
+---------+--------+-------------------+--------------+-----------------------------+-------------------------+
| 481     | FooBar | foobar@nvidia.com | b0xlotzw8zo9 | cosmos [REGISTRY_ADMIN]     | 2018-01-01 00:00:00 UTC |
+---------+--------+-------------------+--------------+-----------------------------+-------------------------+

$ ngc team update-user foobar@nvidia.com REGISTRY_USER --team cosmos

User foobar@nvidia.com information updated.
+---------+--------+-------------------+--------------+----------------------------+-------------------------+
| User Id | Name   | Email             | Org          | Teams [Roles]              | Created Date            |
+---------+--------+-------------------+--------------+----------------------------+-------------------------+
| 481     | FooBar | foobar@nvidia.com | b0xlotzw8zo9 | cosmos [REGISTRY_USER]     | 2018-01-01 00:00:00 UTC |
+---------+--------+-------------------+--------------+----------------------------+-------------------------+

How to remove user from an team?

$ ngc team remove-user foobar@nvidia.com --team cosmos

User: foobar@nvidia.com removed from team: cosmos in org: b0xlotzw8zo9.