org¶

Org Commands

usage: ngc org [--ace <name>] [--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

--ace

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

--team

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

org¶

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

Sub-commands¶

user-group¶

External User Group Commands

ngc org user-group [--ace <name>] [--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

--ace

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

--team

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

user-group¶

: Possible choices: add-member, create, delete, info, list, onboard, onboard-resend, onboard-revoke, remove-member, revoke-access, suspend, update, update-permissions

Sub-commands¶

list¶

List external user groups in an org.

ngc org user-group list [--ace <name>] [--debug] [--format_type <fmt>]
                        [--org <name>] [--team <name>] [--type <type>] [-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

--ace

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

--team

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

--type

Filter by group type. Values: USER_GROUP, DELEGATED_USER_GROUP, DELEGATED_USER_GROUP_INVITATION (pending onboard invitations).

info¶

Get details of a specific external user group.

ngc org user-group info [--ace <name>] [--debug] [--format_type <fmt>]
                        [--org <name>] [--team <name>] [-h]
                        <group-id>

Positional Arguments¶

<group-id>: User Group 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

--ace

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

--team

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

create¶

Create a managed external user group. Org Admin only.

ngc org user-group create [--ace <name>] [--debug] [--description <text>]
                          [--format_type <fmt>] --name <name> [--org <name>]
                          [--resource-group <name>] [--service-roles <roles>]
                          [--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

--ace

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

--team

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

--resource-group

Resource group (team) to associate with the user group.

--service-roles

Comma-separated NGC service roles to grant (e.g. REGISTRY_READ,CATALOG_READ).

--description

Group description (max 512 chars).

Required named arguments¶

--name: Group name (3–64 chars, required).

delete¶

Delete a managed external user group. Org Admin only.

ngc org user-group delete [--ace <name>] [--debug] [--format_type <fmt>]
                          [--org <name>] [--team <name>] [-h]
                          <group-id>

Positional Arguments¶

<group-id>: User Group 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

--ace

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

--team

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

update¶

Update a managed external user group. Org Admin only.

ngc org user-group update [--ace <name>] [--debug] [--description <text>]
                          [--format_type <fmt>] [--name <name>] [--org <name>]
                          [--resource-group <name>] [--service-roles <roles>]
                          [--team <name>] [-h]
                          <group-id>

Positional Arguments¶

<group-id>: User Group 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

--ace

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

--team

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

--resource-group

Updated resource group (team) name.

--service-roles

Updated comma-separated NGC service roles.

--description

Updated group description.

--name

Updated group name (3–64 chars).

add-member¶

Invite one or more external users to a managed external user group by email. Org Admin only.

ngc org user-group add-member [--ace <name>] [--debug] --email <email>
                              [--email-message <text>]
                              [--email-subject <text>] [--format_type <fmt>]
                              [--invitation-expiry <minutes>] [--org <name>]
                              [--role <role>] [--team <name>] [-h]
                              <group-id>

Positional Arguments¶

<group-id>: User Group 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

--ace

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

--team

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

--email-message

Override invitation email body (max 5000 chars).

--email-subject

Override invitation email subject.

--invitation-expiry

Invitation expiry in minutes (0–43200, max 30 days).

--role

Role to assign to invited users. Values: ADMIN, MEMBER (default: MEMBER).

Required named arguments¶

--email: External user email address. Repeat for multiple users.

remove-member¶

Remove a user from a managed external user group. Org Admin only.

ngc org user-group remove-member [--ace <name>] [--debug]
                                 [--format_type <fmt>] [--org <name>]
                                 [--team <name>] --user-id <user-id> [-h]
                                 <group-id>

Positional Arguments¶

<group-id>: User Group 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

--ace

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

--team

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

Required named arguments¶

--user-id: ID of the user to remove.

onboard¶

Send a delegated EUG onboard invitation (NCP Admin only).

ngc org user-group onboard [--ace <name>] [--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

--ace

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

--team

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

onboard-revoke¶

Revoke a pending delegated EUG onboard invitation.

ngc org user-group onboard-revoke [--ace <name>] [--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

--ace

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

--team

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

onboard-resend¶

Resend a delegated EUG onboard invitation.

ngc org user-group onboard-resend [--ace <name>] [--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

--ace

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

--team

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

update-permissions¶

Update permissions granted to a delegated EUG.

ngc org user-group update-permissions [--ace <name>] [--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

--ace

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

--team

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

suspend¶

Suspend all access for a delegated EUG.

ngc org user-group suspend [--ace <name>] [--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

--ace

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

--team

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

revoke-access¶

Permanently remove a delegated EUG's access from the resource org.

ngc org user-group revoke-access [--ace <name>] [--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

--ace

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

--team

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

list¶

List all accessible organizations.

ngc org list [--ace <name>] [--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

--ace

Specify the ACE name. Use "--ace no-ace" to override other sources and specify no ACE. 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 id[=Id], name[=Name], displayName[="Display Name"], description[=Description], type[=Type], ncaAccountNumber[="Cloud Account Number"], billingAccountId[="Cloud Account ID"]. Use quotes with spaces. Multiple column arguments are allowed.

info¶

Get organization details.

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

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

--ace

Specify the ACE name. Use "--ace no-ace" to override other sources and specify no ACE. 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) Add (create) a user to the current organization.

ngc org add-user [--ace <name>] [--debug] [--format_type <fmt>]
                 [--invitation-expiry <duration>] [--message <text>] [--name]
                 [--org <name>] --role <r> [--team <name>] [-h]
                 <email>

Positional Arguments¶

<email>: User Email

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

--ace

Specify the ACE name. Use "--ace no-ace" to override other sources and specify no ACE. 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.

--invitation-expiry

Invitation expiry duration. Options: '1 hour', '6 hours', '24 hours', '1 week', '1 month'. IMPORTANT: Multi-word values must be quoted! Example: --invitation-expiry '1 week'. Default: '24 hours'

--message

Custom invitation message to include in the email. If not provided, uses default message.

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, 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. NOTE: NVIDIA Cloud Account role (Member/Admin) is automatically determined based on NGC role.

update-user¶

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

ngc org update-user [--ace <name>] [--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

--ace

Specify the ACE name. Use "--ace no-ace" to override other sources and specify no ACE. 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: BASE_COMMAND_ADMIN, BASE_COMMAND_USER, BASE_COMMAND_VIEWER, 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: [BASE_COMMAND_ADMIN, BASE_COMMAND_USER, BASE_COMMAND_VIEWER, 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: [BASE_COMMAND_ADMIN, BASE_COMMAND_USER, BASE_COMMAND_VIEWER, 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 organization.

ngc org remove-user [--ace <name>] [--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

--ace

Specify the ACE name. Use "--ace no-ace" to override other sources and specify no ACE. 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 organization.

ngc org delete-invitation [--ace <name>] [--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

--ace

Specify the ACE name. Use "--ace no-ace" to override other sources and specify no ACE. 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 organization.

ngc org list-users [--ace <name>] [--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

--ace

Specify the ACE name. Use "--ace no-ace" to override other sources and specify no ACE. 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.

add-team¶

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

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

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

--ace

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

--team

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

update-team¶

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

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

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

--ace

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

--team

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

remove-team¶

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

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

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

--ace

Specify the ACE name. Use "--ace no-ace" to override other sources and specify no ACE. 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.

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.