Administration commands

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
install license	install licence
unistall license	uninstall licence
status	check the status of the Akamas instance
log	get logs
initialize configuration	initialize Akamas configuration
set configuration	set Akamas configuration

Install License command

An Akamas license is an Akamas resource (see list of Akamas resources) so you can use the following command (see install command) to install a license in an Akamas instance:

akamas install license licenkse.ak

Uninstall License command

An Akamas license is an Akamas resource (see list of Akamas resources) so you can use the following command (see uninstall command) to remove a license from the Akamas installation:

akamas uninstall license <license-id>

Status command

Print the status of the Akamas instance.

akamas status [-d]

with the following options:

Option	Short option	Type	Description
--debug	-d	Flag	Print a detailed status of Akamas instance

Log command

Print the logs of the Akamas services.

akamas status [-d]

with the following options:

Option	Short option	Description	Type	Accepted values	Requires	Mutually exclusive
--debug	-d	Show extended error messages, if presents	Flag	-	-	-
--page-size		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 %Y-%m-%d %H:%M:%S.%f -nw -nd -nh -nm -ns -nms	-	-
--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 %Y-%m-%d %H:%M:%S.%f -nw -nd -nh -nm -ns -nms	-	-
--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 analyzer metrics optimizer license log	-	-
--log-level	-l	Log level	String	TRACE DEBUG INFO WARN ERROR	-	-
--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	-	-	-

Initialize Akamas configuration

Initialize the CLI’s configuration file, either interactively or through the provided options.

akamas init config [options]

with the following options:

Option	Short option	Type	Default	Description
--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].
--workspace	-w	String	default	Active workspace
--echo-only		Flag		Print configuration on stdout

Set Akamas configuration

Set a value in the CLI’s configuration file

akamas set config [options]

with the following options:

Option	Short option	Type	Description
--api-address	-a	String	Set the API address of your Akamas instance
--workspace	-w	String	Set the default workspace
--organization	-o	String	Set your organization
--keyring	-k	String	Set keyring type