Instana backend commands

Entering the commandinstana -helpon the host where the Instana backend is installed, all Instana available commands will be listed.

Available Commands:
configure - Adjust Instana at runtime
debug - Collect compressed debugging information for Instana support
geodb - Adjust the GeoLite2 database for eum data
help - Help about any command
images - Handle docker images for air gap environments
init - Initialize the Instana self-hosted backend on the host, use (-f|--file=) for custom settings.hcl
license - Handle license information for the Instana installation
repair - Repair an Instana installation
restore - Restore an existing instana installation. (-f|--file=) for settings.hcl. (-i|--verify=true/false) for verifiying the backup data (default: false)
settings - Settings handling for Instana installation
start - Start existing Instana self-hosted backend
stop - Stop Instana self-hosted backend
update - Update existing Instana self-hosted backend, use (-f|--file=) for custom settings.hcl
version - Show Instana backend build version

Flags:
--help Help about any command
-v, --verbose Verbose mode

Use "instana [command] --help" for more information about a command.

 

configure


The commandinstana configureadjusts Instana at runtime. For configuration changes due to settings.hcl adjustments,instana updateshould be called instead.

Usage:
instana configure [flags]
instana configure [command]

Available Commands:
admin Reset the default admin user
debug-log Enable debug logging for a specific service for 15 minutes
reset Reset authentication configuration (LDAP/SAML)

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

Use "instana configure [command] --help" for more information about a command.

configure admin


The commandinstana configure adminoverwrites the initial owner for providing administrative access.

Usage:
instana configure admin [(-p|--pass=)password] [flags]

Flags:
-p, --pass string (optional) Set pass for admin account
-u, --user string (optional) Set user of the admin account

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

configure debug-log


The commandinstana configure debug-logis used for the Instana component to activate debug logging for 15 minutes. Afterward, the log data can be archived withinstana debugfor further analysis.

Usage:
instana configure debug-log (instana service name) [flags]

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

configure reset


The commandinstana configure resetresets the given authentication configuration and switches to Instana internal user management.

Usage:
instana configure reset (LDAP/SAML) [flags]

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

 

debug


The commandinstana debugcreates a collection of logging and setting information. It collects compressed debugging information for Instana support. Sensitive data from the configuration will be hidden. This is mainly used to send additional insights to Instana support:https://support.instana.com/

Usage:
instana debug [flags]

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

 

geodb


The commandinstana geodbsupports downloading and updating the GeoLite2 database at runtime. It adjusts the GeoLite2 database for EUM data.

Usage:
instana geodb [flags]
instana geodb [command]

Available Commands:
download Download a new version of the GeoLite2 database
update Update the GeoLite2 database with a downloaded file

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

Use "instana geodb [command] --help" for more information about a command.

geodb download


The commandinstana geodb downloaddownloads a new version of the GeoLite2 database from the given download URL in settings, defaults to 'https://packages.instana.io'.

Usage:
instana geodb download [(-k|--key=)agentKey] [flags]

Flags:
-k, --key string Instana AgentKey, per default gets the agent key from installation

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

geodb update


The commandinstana geodb updateupdates the GeoLite2 database with a previously downloaded tar.gz file.

Usage:
instana geodb update [(-f|--file=)database] [flags]

Flags:
-f, --file string path to the downloaded tar.gz file

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

 

help


The commandinstana helpprovides help for any command in the application. Simply typeinstana help [path to command]for full details.

Usage:
instana help [command] [flags]

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

 

images


The commandinstana imagessupports exporting and importing docker images for air gap installations.

Usage:
instana images [flags]
instana images [command]

Available Commands:
export Export docker images to tar file
import Import docker images from tar file
prune Deletes all no longer needed instana docker images from the cache
pull Pull necessary docker images to local cache
push Push docker images to custom registry
version Display all docker containers including their version

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

Use "instana images [command] --help" for more information about a command.

images export


The commandinstana images exportexports all docker images into a tar file.

Usage:
instana images export [(-k|--key=)agentKey] [flags]

Flags:
-k, --key string Instana AgentKey to access the docker containers from containers.instana.io

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

images import


The commandinstana images import imports all docker images from a tar file.

Usage:
instana images import [(-f|--file=)tar] [flags]

Flags:
-f, --file string path to a tar file containing all docker images

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

images prune


The commandinstana images prunedeletes all no longer needed Instana docker images from the cache.

Usage:
instana images prune [flags]

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

images pull


The commandinstana images pullpulls necessary docker images to the local cache.

Usage:
instana images pull [(-k|--key=)agentKey] [flags]

Flags:
-k, --key string Instana AgentKey to access the docker containers from containers.instana.io

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

images push


The commandinstana images pushpushes docker images to the custom registry.

Usage:
instana images push [(-u|--user=)registryUser (-p|--pass=)registryPass (-r|--url=)registryUrl] [flags]

Flags:
-p, --pass string Registry pass
-r, --url string Registry url
-u, --user string Registry user

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

images version


The commandinstana images versiondisplays all docker containers including their version for the actual installation.

Usage:
instana images version [flags]

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

 

init


The commandinstana initinitializes a new Instana self-hosted installation. In case of resetting data for an existing installation use--forceto refresh(delete) data on existing configuration.

Usage:
instana init [(-f|--file=)settings.hcl] [flags]

Flags:
-f, --file string path to custom settings.hcl
--force force init delete all existing data
-y, --yes disable survey and read settings from settings.hcl

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

 

license


The commandinstana licensesupports downloading your license from the Instana license server and importing a license into your installation. It also supports verifying the current license state.

Usage:
instana license [flags]
instana license [command]

Available Commands:
download Download your license from Instana license management system, without key flag gets the key from installation
import Import a license file to unit installation
verify Verify the state of the license

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

Use "instana license [command] --help" for more information about a command.

license download


The commandinstana license downloadsupports downloading your license from the Instana license management system. Useinstana license importafterward.

Usage:
instana license download [(-k|--key=)salesKey] [flags]

Flags:
-k, --key string Instana SalesKey, per default gets the sales key from installation

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

license import


The commandinstana license importimports a given license file or a license from the execution directory to unit installation.

Usage:
instana license import [(-f|--file=)license] [flags]

Flags:
-f, --file string path to custom license file

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

license verify


The commandinstana license verifyprints the license information from this installation.

Usage:
instana license verify [flags]

Flags:
-f, --file string path to custom license file

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

 

repair


The commandinstana repairrepairs an Instana installation. It will bring up the Instana data stores and run repair operations on them. This might take a long time.

Usage:
instana repair [flags]

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

 

restore


The commandinstana restorerestores an existing Instana installation. (-f|--file=) for settings.hcl. (-i|--verify=true/false) for verifying the backup data (default: false). Based on the settings.hcl and the corresponding data directories Instana will be initialized.

Usage:
instana restore [(-f|--file=settings.hcl) (-i|--verify=true/false)] [flags]

Flags:
-f, --file string path to custom settings.hcl
-i, --verify verify backup data (increases startup time)

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

 

settings


The commandinstana settingssupports creating templates or validating existing settings. It is used for settings handling for Instana installation.

Usage:
instana settings [flags]
instana settings [command]

Available Commands:
generate Create a settings file based on the existing installation settings
template Create a settings.hcl template file
validate Validate settings.hcl configuration file

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

Use "instana settings [command] --help" for more information about a command.

settings generate


The commandinstana settings generatecreates or overrides a settings file based on the existing installation settings.

Usage:
instana settings generate [flags]

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

settings template


The commandinstana settings templatecreates default settings with all possible configuration values for your Instana installation. Can be used to overwrite existing settings with a new empty template.

Usage:
instana settings template [flags]

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

settings validate


The commandinstana settings validatevalidates your settings.hcl and prints possible misconfiguration. All commands that apply configuration changes include a configuration validation upfront.

Usage:
instana settings validate [flags]

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

 

start


The commandinstana startstarts all existing Instana self-hosted backend components on the host. An optional Instana service name arguments start the single service only.

Usage:
instana start [flags]

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

 

stop


The commandinstana stopstops Instana self-hosted backend on the host. An optional Instana service name argument stops the single service only.

Usage:
instana stop [flags]

Flags:
-y, --yes automatic yes to prompts

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

 

update


The commandinstana updateupdates all existing Instana self-hosted backend components on the host. This includes applying configuration changes and upgrading already installed components. To upgrade Instana components you need to upgrade your instana-console first. Use (-f|--file=) for custom settings.hcl.

Usage:
instana update [(-f|--file=)settings.hcl] [flags]

Flags:
-f, --file string path to custom settings.hcl

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

 

version


The commandinstana versionshows the Instana backend build commit version including the actual commit id.

Usage:
instana version [flags]

Global Flags:
--help Help about any command
-v, --verbose Verbose mode

 

 

 

 

 

 

 

Have more questions? Submit a request

Comments