N
N
Neu.ro CLI Reference
Search…
⌃K

admin

Cluster administration commands

Usage

neuro admin [OPTIONS] COMMAND [ARGS]...
Cluster administration commands.
Commands:
Usage
Description
Create a new cluster
Add user access to specified cluster
​add-org​
Create a new org
Add org access to specified cluster
Add given values to org cluster balance
Add user access to specified org
Add new project to specified cluster
Add user access to specified project
Add new resource preset
Add given values to user quota
Create a cluster configuration file
List users in specified cluster
Print the list of available clusters
Get info about org quota in given cluster
Print the list of all orgs in the cluster
List users in specified org
​get-orgs​
Print the list of available orgs
List users in specified project
Print the list of all projects in the cluster
Get info about user quota in given cluster
Drop a cluster
Remove user access from the cluster
Drop a org
Drop an org cluster
Remove user access from the org
Remove user access from the project
Remove resource preset
Set org cluster credits to given value
Set org cluster defaults to given value
Set org cluster quota to given values
Set user credits to given value
Set user quota to given values
Show available cluster options
Update a cluster
Update cluster node pool
Update org cluster quotas
Update project settings
Update user access to specified project
Update existing resource preset

add-cluster

Create a new cluster

Usage

neuro admin add-cluster [OPTIONS] CLUSTER_NAME CONFIG
Create a new cluster.
Creates cluster entry on admin side and then start its provisioning using provided config.

Options

Name
Description
--help
Show this message and exit.
--default-credits AMOUNT
Default credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-jobs AMOUNT
Default maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--default-role [ROLE]
Default role for new users added to cluster [default: user]

add-cluster-user

Add user access to specified cluster

Usage

neuro admin add-cluster-user [OPTIONS] CLUSTER_NAME USER_NAME [ROLE]
Add user access to specified cluster.
The command supports one of 3 user roles: admin, manager or user.

Options

Name
Description
--help
Show this message and exit.
-c, --credits AMOUNT
Credits amount to set (`unlimited' stands for no limit)
-j, --jobs AMOUNT
Maximum running jobs quota (`unlimited' stands for no limit)
--org ORG
org name for org-cluster users

add-org

Create a new org

Usage

neuro admin add-org [OPTIONS] ORG_NAME
Create a new org.

Options

Name
Description
--help
Show this message and exit.

add-org-cluster

Add org access to specified cluster

Usage

neuro admin add-org-cluster [OPTIONS] CLUSTER_NAME ORG_NAME
Add org access to specified cluster.

Options

Name
Description
--help
Show this message and exit.
-c, --credits AMOUNT
Credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-credits AMOUNT
Default credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-jobs AMOUNT
Default maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--default-role [ROLE]
Default role for new users added to org cluster [default: user]
-j, --jobs AMOUNT
Maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--storage-size AMOUNT
Storage size, ignored for storage types with elastic storage size

add-org-cluster-credits

Add given values to org cluster balance

Usage

neuro admin add-org-cluster-credits [OPTIONS] CLUSTER_NAME ORG_NAME
Add given values to org cluster balance

Options

Name
Description
--help
Show this message and exit.
-c, --credits AMOUNT
Credits amount to add

add-org-user

Add user access to specified org

Usage

neuro admin add-org-user [OPTIONS] ORG_NAME USER_NAME [ROLE]
Add user access to specified org.
The command supports one of 3 user roles: admin, manager or user.

Options

Name
Description
--help
Show this message and exit.

add-project

Add new project to specified cluster

Usage

neuro admin add-project [OPTIONS] CLUSTER_NAME NAME
Add new project to specified cluster.

Options

Name
Description
--help
Show this message and exit.
--default
Is this project is default, e.g. new cluster users will be automatically added to it
--default-role [ROLE]
Default role for new users added to project [default: writer]
--org ORG
org name for org-cluster projects

add-project-user

Add user access to specified project

Usage

neuro admin add-project-user [OPTIONS] CLUSTER_NAME PROJECT_NAME USER_NAME [ROLE]
Add user access to specified project.
The command supports one of 4 user roles: reader, writer, manager or admin.

Options

Name
Description
--help
Show this message and exit.
--org ORG
org name for org-cluster projects

add-resource-preset

Add new resource preset

Usage

neuro admin add-resource-preset [OPTIONS] PRESET_NAME
Add new resource preset

Options

Name
Description
--help
Show this message and exit.
-c, --cpu NUMBER
Number of CPUs [default: 0.1]
--credits-per-hour AMOUNT
Price of running job of this preset for an hour in credits [default: 0]
-g, --gpu NUMBER
Number of GPUs
--gpu-model MODEL
GPU model
-m, --memory AMOUNT
Memory amount [default: 1GB]
--preemptible-node / --non-preemptible-node
Use a lower-cost preemptible instance [default: non-preemptible-node]
-p, --scheduler / -P, --no-scheduler
Use round robin scheduler for jobs [default: no-scheduler]
--tpu-sw-version VERSION
TPU software version
--tpu-type TYPE
TPU type

add-user-credits

Add given values to user quota

Usage

neuro admin add-user-credits [OPTIONS] CLUSTER_NAME USER_NAME
Add given values to user quota

Options

Name
Description
--help
Show this message and exit.
-c, --credits AMOUNT
Credits amount to add [required]
--org ORG
org name for org-cluster users

generate-cluster-config

Create a cluster configuration file

Usage

neuro admin generate-cluster-config [OPTIONS] [CONFIG]
Create a cluster configuration file.

Options

Name
Description
--help
Show this message and exit.
--type [aws | gcp | azure | vcd]
​

get-cluster-users

List users in specified cluster

Usage

neuro admin get-cluster-users [OPTIONS] [CLUSTER_NAME]
List users in specified cluster

Options

Name
Description
--help
Show this message and exit.
--org ORG
org name for org-cluster users

get-clusters

Print the list of available clusters

Usage

neuro admin get-clusters [OPTIONS]
Print the list of available clusters.

Options

Name
Description
--help
Show this message and exit.

get-org-cluster-quota

Get info about org quota in given cluster

Usage

neuro admin get-org-cluster-quota [OPTIONS] CLUSTER_NAME ORG_NAME
Get info about org quota in given cluster

Options

Name
Description
--help
Show this message and exit.

get-org-clusters

Print the list of all orgs in the cluster

Usage

neuro admin get-org-clusters [OPTIONS] CLUSTER_NAME
Print the list of all orgs in the cluster

Options

Name
Description
--help
Show this message and exit.

get-org-users

List users in specified org

Usage

neuro admin get-org-users [OPTIONS] ORG_NAME
List users in specified org

Options

Name
Description
--help
Show this message and exit.

get-orgs

Print the list of available orgs

Usage

neuro admin get-orgs [OPTIONS]
Print the list of available orgs.

Options

Name
Description
--help
Show this message and exit.

get-project-users

List users in specified project

Usage

neuro admin get-project-users [OPTIONS] CLUSTER_NAME PROJECT_NAME
List users in specified project

Options

Name
Description
--help
Show this message and exit.
--org ORG
org name for org-cluster projects

get-projects

Print the list of all projects in the cluster

Usage

neuro admin get-projects [OPTIONS] CLUSTER_NAME
Print the list of all projects in the cluster

Options

Name
Description
--help
Show this message and exit.
--org ORG
org name for org-cluster projects

get-user-quota

Get info about user quota in given cluster

Usage

neuro admin get-user-quota [OPTIONS] CLUSTER_NAME USER_NAME
Get info about user quota in given cluster

Options

Name
Description
--help
Show this message and exit.
--org ORG
org name for org-cluster users

remove-cluster

Drop a cluster

Usage

neuro admin remove-cluster [OPTIONS] CLUSTER_NAME
Drop a cluster
Completely removes cluster from the system.

Options

Name
Description
--help
Show this message and exit.
--force
Skip prompt

remove-cluster-user

Remove user access from the cluster

Usage

neuro admin remove-cluster-user [OPTIONS] CLUSTER_NAME USER_NAME
Remove user access from the cluster.

Options

Name
Description
--help
Show this message and exit.
--org ORG
org name for org-cluster users

remove-org

Drop a org

Usage

neuro admin remove-org [OPTIONS] ORG_NAME
Drop a org
Completely removes org from the system.

Options

Name
Description
--help
Show this message and exit.
--force
Skip prompt

remove-org-cluster

Drop an org cluster

Usage

neuro admin remove-org-cluster [OPTIONS] CLUSTER_NAME ORG_NAME
Drop an org cluster
Completely removes org from the cluster.

Options

Name
Description
--help
Show this message and exit.
--force
Skip prompt

remove-org-user

Remove user access from the org

Usage

neuro admin remove-org-user [OPTIONS] ORG_NAME USER_NAME
Remove user access from the org.

Options

Name
Description
--help
Show this message and exit.

remove-project-user

Remove user access from the project

Usage

neuro admin remove-project-user [OPTIONS] CLUSTER_NAME PROJECT_NAME USER_NAME
Remove user access from the project.

Options

Name
Description
--help
Show this message and exit.
--org ORG
org name for org-cluster projects

remove-resource-preset

Remove resource preset

Usage

neuro admin remove-resource-preset [OPTIONS] PRESET_NAME
Remove resource preset

Options

Name
Description
--help
Show this message and exit.

set-org-cluster-credits

Set org cluster credits to given value

Usage

neuro admin set-org-cluster-credits [OPTIONS] CLUSTER_NAME ORG_NAME
Set org cluster credits to given value

Options

Name
Description
--help
Show this message and exit.
-c, --credits AMOUNT
Credits amount to set (`unlimited' stands for no limit) [required]

set-org-cluster-defaults

Set org cluster defaults to given value

Usage

neuro admin set-org-cluster-defaults [OPTIONS] CLUSTER_NAME ORG_NAME
Set org cluster defaults to given value

Options

Name
Description
--help
Show this message and exit.
--default-credits AMOUNT
Default credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-jobs AMOUNT
Default maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--default-role [ROLE]
Default role for new users added to org cluster [default: user]

set-org-cluster-quota

Set org cluster quota to given values

Usage

neuro admin set-org-cluster-quota [OPTIONS] CLUSTER_NAME ORG_NAME
Set org cluster quota to given values

Options

Name
Description
--help
Show this message and exit.
-j, --jobs AMOUNT
Maximum running jobs quota (`unlimited' stands for no limit) [required]

set-user-credits

Set user credits to given value

Usage

neuro admin set-user-credits [OPTIONS] CLUSTER_NAME USER_NAME
Set user credits to given value

Options

Name
Description
--help
Show this message and exit.
-c, --credits AMOUNT
Credits amount to set (`unlimited' stands for no limit) [required]
--org ORG
org name for org-cluster users

set-user-quota

Set user quota to given values

Usage

neuro admin set-user-quota [OPTIONS] CLUSTER_NAME USER_NAME
Set user quota to given values

Options

Name
Description
--help
Show this message and exit.
-j, --jobs AMOUNT
Maximum running jobs quota (`unlimited' stands for no limit) [required]
--org ORG
org name for org-cluster users

show-cluster-options

Show available cluster options

Usage

neuro admin show-cluster-options [OPTIONS]
Show available cluster options.

Options

Name
Description
--help
Show this message and exit.
--type [aws | gcp | azure]
​

update-cluster

Update a cluster

Usage

neuro admin update-cluster [OPTIONS] CLUSTER_NAME
Update a cluster.

Options

Name
Description
--help
Show this message and exit.
--default-credits AMOUNT
Default credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-jobs AMOUNT
Default maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--default-role [ROLE]
Default role for new users added to cluster [default: user]

update-node-pool

Update cluster node pool

Usage

neuro admin update-node-pool [OPTIONS] CLUSTER_NAME NODE_POOL_NAME
Update cluster node pool.

Options

Name
Description
--help
Show this message and exit.
--idle-size NUMBER
Number of idle nodes in the node pool.

update-org-cluster

Update org cluster quotas

Usage

neuro admin update-org-cluster [OPTIONS] CLUSTER_NAME ORG_NAME
Update org cluster quotas.

Options

Name
Description
--help
Show this message and exit.
-c, --credits AMOUNT
Credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-credits AMOUNT
Default credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-jobs AMOUNT
Default maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--default-role [ROLE]
Default role for new users added to org cluster [default: user]
-j, --jobs AMOUNT
Maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]

update-project

Update project settings

Usage

neuro admin update-project [OPTIONS] CLUSTER_NAME NAME
Update project settings.

Options

Name
Description
--help
Show this message and exit.
--default
Is this project is default, e.g. new cluster users will be automatically added to it
--default-role [ROLE]
Default role for new users added to project [default: writer]
--org ORG
org name for org-cluster projects

update-project-user

Update user access to specified project

Usage

neuro admin update-project-user [OPTIONS] CLUSTER_NAME PROJECT_NAME USER_NAME [ROLE]
Update user access to specified project.
The command supports one of 4 user roles: reader, writer, manager or admin.

Options

Name
Description
--help
Show this message and exit.
--org ORG
org name for org-cluster projects

update-resource-preset

Update existing resource preset

Usage

neuro admin update-resource-preset [OPTIONS] PRESET_NAME
Update existing resource preset

Options

Name
Description
--help
Show this message and exit.
-c, --cpu NUMBER
Number of CPUs
--credits-per-hour AMOUNT
Price of running job of this preset for an hour in credits
-g, --gpu NUMBER
Number of GPUs
--gpu-model MODEL
GPU model
-m, --memory AMOUNT
Memory amount
--preemptible-node / --non-preemptible-node
Use a lower-cost preemptible instance
-p, --scheduler / -P, --no-scheduler
Use round robin scheduler for jobs
--tpu-sw-version VERSION
TPU software version
--tpu-type TYPE
TPU type
Commands - Previous
acl
Next - Commands
blob
Last modified 4mo ago