Resource management commands
Last updated
Last updated
This page describes all commands that allow Akamas resources to be managed with their options (see also common options available for all commands).
Command | Description |
---|---|
The following table describes the common options available for all commands:
Option | Short option | Type | Description |
---|---|---|---|
The Akamas CLI allows using a set of alias or shortcuts for many resources.
Any resource can be specified using either the singular or plural form. Furthermore, the shortcuts listed below are available:
You can print the list of available aliases with the following command
This command builds the Akamas resource described in the provided YAML file.
Create the Akamas resource described in the provided YAML file.
Delete an Akamas resource, identified by UUID or name.
with the following options:
List the resources for the selected type with their id, name, and description. Additional resource-specific fields can be shown.
with the following options:
Describe an Akamas resource with all its fields.
with the following options:
Notice that this command does not support the resource type System.
Update an Akamas resource, identified by UUID or name.
with the following options:
Install a License or an Optimization Pack
with the following options:
Uninstall a License or an Optimization Pack
with the following options:
Start the execution of a Study.
Stop the execution of a Study. Once stopped, the execution cannot be resumed.
To export a study, the study name or the study UUID can be used from the command line.
An optional filename can be specified, with a relative or absolute path:
The exported information will be saved in tar.gz format.
The following entities are exported:
The Study
The Steps of the Study
The Experiments of the Study
The Trials of the Study
The Workflow to which the Study refers
The Timeseries collected during the study run
The System to which the Study refers
The Component related to the Study's System
The ComponentType of each Component
The Metrics definitions of each ComponentTypes
The Parameters definitions of each ComponentTypes
Notice: this operation can require a long time, depending on the quantity of data to be collected. During this time the CLI will wait for Akamas to send the exported package. Do not interrupt the CLI during this phase, as otherwise, the process will need to be restarted from the beginning.
Notice: please make sure that you have installed the latest versions of the optimization packs before starting the import: this way, the import procedure will bind the studies to the latest optimization packs version (i.e. the installed ones) instead of importing the (possibly) old ones from the source system.
Use the following command to import a study into an existing Akamas instance:
Where FILENAME refers to the file of a previously exported study.
When imported, the following entities will have a new UUID:
Study
Workflow
System
Component
ComponentType
Metrics
Parameters
In case a resource that is being imported has the same name as an existing one, the existing entity will not be deleted. The existing entity (with its UUID) will be used instead of the imported one.
All steps, experiments, and trials will maintain the same id and, therefore, the same execution order as the original exported study.
Notice: this operation can require a long time. If the CLI shows a timeout error or if the operation is interrupted, the import will continue on the Akamas server.
Option | Short option | Type | Description |
---|---|---|---|
Option | Short option | Type | Values | Default | Description |
---|---|---|---|---|---|
Option | Short option | Type | Values | Default | Description |
---|---|---|---|---|---|
Option | Short option | Type | Values | Default | Description |
---|---|---|---|---|---|
Option | Short option | Type | Description |
---|---|---|---|
Option | Short option | Type | Description |
---|---|---|---|