Akamas Docs
3.6
3.6
  • Home
  • Getting started
    • Introduction
    • Insights for Kubernetes
    • Free Trial
    • Licensing
    • Deployment
      • Cloud Hosting
    • Security
    • Maintenance & Support (M&S) Services
      • Customer Support Services
      • Support levels for Customer Support Services
      • Support levels for software versions
      • Support levels with Akamas
  • Installing
    • Architecture
    • Docker compose installation
      • Prerequisites
        • Hardware Requirements
        • Software Requirements
        • Network requirements
      • Install Akamas dependencies
      • Install the Akamas Server
        • Online installation mode
          • Online installation behind a Proxy server
        • Offline installation mode
        • Changing UI Ports
        • Setup HTTPS configuration
      • Troubleshoot Docker installation issues
    • Kubernetes installation
      • Prerequisites
        • Cluster Requirements
        • Software Requirements
      • Install Akamas
        • Online Installation
        • Offline Installation - Private registry
      • Installing on OpenShift
      • Accessing Akamas
      • Useful commands
      • Selecting Cluster Nodes
    • Install the CLI
      • Setup the CLI
      • Initialize the CLI
      • Change CLI configuration
      • Use a proxy server
    • Verify the installation
    • Installing the toolbox
    • Install the license
    • Manage anonymous data collection
  • Managing Akamas
    • Akamas logs
    • Audit logs
    • Upgrade Akamas
      • Docker compose
      • Kubernetes
    • Monitor Akamas status
    • Backup & Recover of the Akamas Server
    • Users management
      • Accessing Keycloak admin console
      • Configure an external identity provider
        • Azure Active Directory
        • Google
      • Limit users sessions
        • Local users
        • Identity provider users
    • Collecting support information
  • Using
    • System
    • Telemetry
    • Workflow
    • Study
      • Offline Study
      • Live Study
        • Analyzing results of live optimization studies
      • Windowing
      • Parameters and constraints
  • Optimization Guides
    • Optimize application costs and resource efficiency
      • Kubernetes microservices
        • Optimize cost of a Kubernetes deployment subject to Horizontal Pod Autoscaler
        • Optimize cost of a Kubernetes microservice while preserving SLOs in production
        • Optimize cost of a Java microservice on Kubernetes while preserving SLOs in production
      • Application runtime
        • Optimizing a sample Java OpenJDK application
        • Optimizing cost of a Node.js application with performance tests
        • Optimizing cost of a Golang application with performance tests
        • Optimizing cost of a .NET application with performance tests
      • Applications running on cloud instances
        • Optimizing a sample application running on AWS
      • Spark applications
        • Optimizing a Spark application
    • Optimize application performance and reliability
      • Kubernetes microservices
        • Optimizing cost of a Kubernetes microservice while preserving SLOs in production
        • Optimizing cost of a Java microservice on Kubernetes while preserving SLOs in production
  • Integrating
    • Integrating Telemetry Providers
      • CSV provider
        • Install CSV provider
        • Create CSV telemetry instances
      • Dynatrace provider
        • Install Dynatrace provider
        • Create Dynatrace telemetry instances
          • Import Key Requests
      • Prometheus provider
        • Install Prometheus provider
        • Create Prometheus telemetry instances
        • CloudWatch Exporter
        • OracleDB Exporter
      • Spark History Server provider
        • Install Spark History Server provider
        • Create Spark History Server telemetry instances
      • NeoLoadWeb provider
        • Install NeoLoadWeb telemetry provider
        • Create NeoLoadWeb telemetry instances
      • LoadRunner Professional provider
        • Install LoadRunner Professional provider
        • Create LoadRunner Professional telemetry instances
      • LoadRunner Enterprise provider
        • Install LoadRunner Enterprise provider
        • Create LoadRunner Enterprise telemetry instances
      • AWS provider
        • Install AWS provider
        • Create AWS telemetry instances
    • Integrating Configuration Management
    • Integrating with pipelines
    • Integrating Load Testing
      • Integrating NeoLoad
      • Integrating LoadRunner Professional
      • Integrating LoadRunner Enterprise
  • Reference
    • Glossary
      • System
      • Component
      • Metric
      • Parameter
      • Component Type
      • Workflow
      • Telemetry Provider
      • Telemetry Instance
      • Optimization Pack
      • Goals & Constraints
      • KPI
      • Optimization Study
      • Workspace
      • Safety Policies
    • Construct templates
      • System template
      • Component template
      • Parameter template
      • Metric template
      • Component Types template
      • Telemetry Provider template
      • Telemetry Instance template
      • Workflows template
      • Study template
        • Goal & Constraints
        • Windowing policy
          • Trim windowing
          • Stability windowing
        • Parameter selection
        • Metric selection
        • Workload selection
        • KPIs
        • Steps
          • Baseline step
          • Bootstrap step
          • Preset step
          • Optimize step
        • Parameter rendering
        • Optimizer Options
    • Workflow Operators
      • General operator arguments
      • Executor Operator
      • FileConfigurator Operator
      • LinuxConfigurator Operator
      • WindowsExecutor Operator
      • WindowsFileConfigurator Operator
      • Sleep Operator
      • OracleExecutor Operator
      • OracleConfigurator Operator
      • SparkSSHSubmit Operator
      • SparkSubmit Operator
      • SparkLivy Operator
      • NeoLoadWeb Operator
      • LoadRunner Operator
      • LoadRunnerEnteprise Operator
    • Telemetry metric mapping
      • Dynatrace metrics mapping
      • Prometheus metrics mapping
      • NeoLoadWeb metrics mapping
      • Spark History Server metrics mapping
      • LoadRunner metrics mapping
    • Optimization Packs
      • Linux optimization pack
        • Amazon Linux
        • Amazon Linux 2
        • Amazon Linux 2022
        • CentOS 7
        • CentOS 8
        • RHEL 7
        • RHEL 8
        • Ubuntu 16.04
        • Ubuntu 18.04
        • Ubuntu 20.04
      • DotNet optimization pack
        • DotNet Core 3.1
      • Java OpenJDK optimization pack
        • Java OpenJDK 8
        • Java OpenJDK 11
        • Java OpenJDK 17
      • OpenJ9 optimization pack
        • IBM J9 VM 6
        • IBM J9 VM 8
        • Eclipse Open J9 11
      • Node JS optimization pack
        • Node JS 18
      • GO optimization pack
        • GO 1
      • Web Application optimization pack
        • Web Application
      • Docker optimization pack
        • Container
      • Kubernetes optimization pack
        • Horizontal Pod Autoscaler v1
        • Horizontal Pod Autoscaler v2
        • Kubernetes Pod
        • Kubernetes Container
        • Kubernetes Workload
        • Kubernetes Namespace
        • Kubernetes Cluster
      • WebSphere optimization pack
        • WebSphere 8.5
        • WebSphere Liberty ND
      • AWS optimization pack
        • EC2
        • Lambda
      • PostgreSQL optimization pack
        • PostgreSQL 11
        • PostgreSQL 12
      • Cassandra optimization pack
        • Cassandra
      • MySQL Database optimization pack
        • MySQL 8.0
      • Oracle Database optimization pack
        • Oracle Database 12c
        • Oracle Database 18c
        • Oracle Database 19c
        • RDS Oracle Database 11g
        • RDS Oracle Database 12c
      • MongoDB optimization pack
        • MongoDB 4
        • MongoDB 5
      • Elasticsearch optimization pack
        • Elasticsearch 6
      • Spark optimization pack
        • Spark Application 2.2.0
        • Spark Application 2.3.0
        • Spark Application 2.4.0
    • Command Line commands
      • Administration commands
      • User and Workspace management commands
      • Authentication commands
      • Resource management commands
      • Optimizer options commands
    • Release Notes
  • Knowledge Base
    • Performing load testing to support optimization activities
    • Creating custom optimization packs
    • Setting up a Konakart environment for testing Akamas
    • Modeling a sample Java-based e-commerce application (Konakart)
    • Optimizing a web application
    • Optimizing a sample Java OpenJ9 application
    • Optimizing a sample Linux system
    • Optimizing a MongoDB server instance
    • Optimizing a Kubernetes application
    • Leveraging Ansible to automate AWS instance management
    • Guidelines for optimizing AWS EC2 instances
    • Optimizing an Oracle Database server instance
    • Optimizing an Oracle Database for an e-commerce service
    • Guidelines for optimizing Oracle RDS
    • Optimizing a MySQL server database running Sysbench
    • Optimizing a MySQL server database running OLTPBench
    • Optimizing a live full-stack deployment (K8s + JVM)
    • Setup Instana integration
    • Setup Locust telemetry via CSV
    • Setup AppDynamics integration
Powered by GitBook
On this page
  • Install License command
  • Uninstall License command
  • Status command
  • Log command
  • Initialize Akamas configuration
  • Set Akamas configuration

Was this helpful?

Export as PDF
  1. Reference
  2. Command Line commands

Administration commands

Last updated 1 year ago

Was this helpful?

This page describes all commands that allow to be managed with their options (see also available for all commands).

Command
Description

install license

uninstall license

check the status of the Akamas instance

get logs

initialize Akamas configuration

set Akamas configuration

Install License command

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:

akamas install license licenkse.ak

Uninstall License command

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:

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

--method

-m

local, oauth2

Set the default authentication method

--keyring

-k

String

Set keyring type

--verify-ssl

-v

Boolean

Set Verify SSL

install license
unistall license
status
log
initialize configuration
set configuration
Akamas resources
common options
Akamas resources
Akamas resources
install command
uninstall command