This page describes all commands that allow Akamas resources to be managed with their options (see also common options available for all commands).
install licence
uninstall licence
check the status of the Akamas instance
An Akamas license is an Akamas resource (see list of ) so you can use the following command (see ) to install a license in an Akamas instance:
An Akamas license is an Akamas resource (see list of ) so you can use the following command (see ) to remove a license from the Akamas installation:
Print the status of the Akamas instance.
with the following options:
Print the logs of the Akamas services.
with the following options:
Initialize the CLI’s configuration file, either interactively or through the provided options.
with the following options:
Set a value in the CLI’s configuration file
with the following options:
Number of log's lines to be retrieved at one time
Integer
(0, 65536)
-
no-pagination
dump
--no-pagination
Disable pagination and print all logs
Flag
-
-
page-size
dump
--dump
Output logs without pagination and formatting
Flag
-
-
page-size
no-pagination
--workspace
-ws
UUID or name of the Workspace to visualize. When empty, system logs will be returned instead
String
-
-
-
--from
-f
The start timestamp or timedelta of the logs
String
%Y-%m-%d
%Y-%m-%dT%H:%M:%S
%Y-%m-%d %H:%M:%S
%Y-%m-%dT%H:%M:%S.%f
-
-
--to
-t
The end timestamp or timedelta of the logs
String
%Y-%m-%d
%Y-%m-%dT%H:%M:%S
%Y-%m-%d %H:%M:%S
%Y-%m-%dT%H:%M:%S.%f
-
-
--study
-s
UUID or name of the Study
String
UUID
-
-
-
--exp
-e
Number of the experiment
Integer
-
study
-
--trial
Number of the trial
Integer
-
study
exp
--system
-y
UUID or name of the System
String
UUID
-
--workflow
-w
UUID or name of the Workflow
String
UUID
-
--service
-S
Name of the Akamas Service
String
system
campaign
telemetry
orchestrator
-
-
--log-level
-l
Log level
String
TRACE
DEBUG
INFO
WARN
-
-
--without-metadata
Print only timestamp and message
Flag
-
-
-
--sorting
Sorting order of the printed logs
String
asc
desc
<MESSAGE>
Regular expression against the message
String
-
-
-
-w
String
default
Active workspace
--echo-only
Flag
Print configuration on stdout
--keyring
-k
String
Set keyring type
get logs
initialize Akamas configuration
set Akamas configuration
--debug
-d
Flag
Print a detailed status of Akamas instance
--debug
-d
Show extended error messages, if presents
Flag
-
-
-
--page-size
--api-address
-a
String
http://localhost:8000
Api address
--default-local
-l
Flag
Configure the Akamas CLI for localhost NOTE: This argument is mutually exclusive with arguments: [api_address].
--api-address
-a
String
Set the API address of your Akamas instance
--workspace
-w
String
Set the default workspace
--organization
-o
String
--workspace
Set your organization
akamas install license licenkse.akakamas uninstall license <license-id>akamas status [-d]akamas status [-d]akamas init config [options]akamas set config [options]%Y-%m-%d %H:%M:%S.%f
-nw
-nd
-nh
-nm
-ns
-nms
%Y-%m-%d %H:%M:%S.%f
-nw
-nd
-nh
-nm
-ns
-nms
analyzer
metrics
optimizer
license
log