Systems¶
Support for the Tapis resource management systems is provided by the systems command set. Helper workflows (such as assistance with SSH keys and testing newly created systems) will be added in coming releases.
General Commands¶
systems list¶
List available Systems
tapis systems list
[--sort-ascending | --sort-descending]
[-l INT]
[-o INT]
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-l
INT
,
--limit
INT
¶ Limit to N records (default: 100)
-
-o
INT
,
--offset
INT
¶ Skip first N records
Replaces legacy CLI command “systems-list”
systems show¶
Show details of a System
tapis systems show SYSTEM_ID
-
SYSTEM_ID
¶
System identifier
Replaces legacy CLI command “systems-list”
systems history¶
Show history for a System
tapis systems history
[--sort-ascending | --sort-descending]
[-l INT]
[-o INT]
SYSTEM_ID
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-l
INT
,
--limit
INT
¶ Limit to N records (default: 100)
-
-o
INT
,
--offset
INT
¶ Skip first N records
-
SYSTEM_ID
¶
System identifier
Replaces legacy CLI command “systems-history”
systems create¶
Create a new System
tapis systems create
[-F FILEPATH]
[--ini FILEPATH]
[--login-username USERNAME]
[--login-public-key FILE]
[--login-private-key FILE]
[--login-password PASSWORD]
[--storage-username USERNAME]
[--storage-public-key FILE]
[--storage-private-key FILE]
[--storage-password PASSWORD]
-
-F
FILEPATH
,
--file
FILEPATH
¶ JSON payload file
-
--ini
FILEPATH
¶ .ini file (project.ini)
-
--login-username
USERNAME
¶ Username for SSH login on the System
-
--login-public-key
FILE
¶ Public key for SSH login on the System
-
--login-private-key
FILE
¶ Private key for SSH login on the System
-
--login-password
PASSWORD
¶ Password for SSH login on the System
-
--storage-username
USERNAME
¶ Username for SFTP storage on the System
-
--storage-public-key
FILE
¶ Public key for SFTP storage on the System
-
--storage-private-key
FILE
¶ Private key for SFTP storage on the System
-
--storage-password
PASSWORD
¶ Password for SFTP storage on the System
Replaces legacy CLI command “systems-addupdate”
systems update¶
Update an existing System
tapis systems update
[-F FILEPATH]
[--ini FILEPATH]
[--login-username USERNAME]
[--login-public-key FILE]
[--login-private-key FILE]
[--login-password PASSWORD]
[--storage-username USERNAME]
[--storage-public-key FILE]
[--storage-private-key FILE]
[--storage-password PASSWORD]
SYSTEM_ID
-
-F
FILEPATH
,
--file
FILEPATH
¶ JSON payload file
-
--ini
FILEPATH
¶ .ini file (project.ini)
-
--login-username
USERNAME
¶ Username for SSH login on the System
-
--login-public-key
FILE
¶ Public key for SSH login on the System
-
--login-private-key
FILE
¶ Private key for SSH login on the System
-
--login-password
PASSWORD
¶ Password for SSH login on the System
-
--storage-username
USERNAME
¶ Username for SFTP storage on the System
-
--storage-public-key
FILE
¶ Public key for SFTP storage on the System
-
--storage-private-key
FILE
¶ Private key for SFTP storage on the System
-
--storage-password
PASSWORD
¶ Password for SFTP storage on the System
-
SYSTEM_ID
¶
System identifier
Replaces legacy CLI command “systems-addupdate”
Sharing Commands¶
Manage access by other users to Tapis systems that you control.
systems roles drop¶
Drop all granted roles from a System
tapis systems roles drop
[--sort-ascending | --sort-descending]
[-l INT]
[-o INT]
SYSTEM_ID
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-l
INT
,
--limit
INT
¶ Limit to N records (default: 100)
-
-o
INT
,
--offset
INT
¶ Skip first N records
-
SYSTEM_ID
¶
System identifier
Replaces legacy CLI command “systems-roles-delete”
systems roles grant¶
Grant a user role on a System
tapis systems roles grant SYSTEM_ID USERNAME ROLE
-
SYSTEM_ID
¶
System identifier
-
USERNAME
¶
Tapis username
-
ROLE
¶
Role (GUEST| USER| PUBLISHER| ADMIN| OWNER)
Replaces legacy CLI command “systems-roles-addupdate”
systems roles list¶
List user roles on a System
tapis systems roles list
[--sort-ascending | --sort-descending]
[-l INT]
[-o INT]
SYSTEM_ID
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-l
INT
,
--limit
INT
¶ Limit to N records (default: 100)
-
-o
INT
,
--offset
INT
¶ Skip first N records
-
SYSTEM_ID
¶
System identifier
Replaces legacy CLI command “systems-roles-list”
Search Commands¶
Search for Tapis Systems by several criteria. Please consult
tapis systems search -h
for guidance.
Queues Commands¶
View and interact with queues on a Tapis execution system.
systems queues list¶
List virtual queues on a System
tapis systems queues list
[--sort-ascending | --sort-descending]
[-l INT]
[-o INT]
SYSTEM_ID
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-l
INT
,
--limit
INT
¶ Limit to N records (default: 100)
-
-o
INT
,
--offset
INT
¶ Skip first N records
-
SYSTEM_ID
¶
System identifier
Replaces legacy CLI command “systems-queues-list”