Virtual Appliance CLI

The Virtual Appliance command line utility (CLI) is a service that enables you to perform tasks such as applying licenses or viewing the pod status. This utility is bundled with the Virtual Appliance package.

Syntax

The appdcli command is structured hierarchically. The main command is followed by a subcommand. The subcommand has various other subcommands representing specific tasks you can perform. This is the syntax of the command that you can use to perform the Virtual Appliance tasks:

appdcli [global_options] <subcommand> [subcommand_options] [arguments]

Subcommands

The following table lists the available subcommands. You can use any of the subcommands followed by their specific options and arguments:


Subcommand	Usage
`start`	Start Splunk AppDynamics, Anomaly Detection, and Secure Application services.
`sync`	Synchronize services.
`ping`	Display the ping status.
`license`	Update or apply the license.
`key`	Update the access key.
`run`	Run the specified task. Valid tasks are: `eum_license` - Provision EUM license. `bootstrap` - Run bootstrap job. `bootstrap_hybrid` - Run bootstrap hybrid job. `secureapp` - Run Secure Application commands. `infra_inspect` - Run infra inspect. `mysql_restore` - Run MySQL restore from outage. `list_kafka_topics` - List Kafka topics. `list_images` - List registry images. `backup` - Create backup for upgrade. `restore` - Restore for upgrade. `es_backup` - ElasticSearch backup. `pg_backup` - PostgreSQL backup. `mysql_backup` - MySQL backup. Task names are case-sensitive.
`techsupport`	Collect logs that you can submit to Splunk AppDynamics support.
`stop`	Stop Splunk AppDynamics, Anomaly Detection, and Secure Application services.

Examples

To get help on the license subcommand, use:

./appdcli license -h

Similarly, you can explore the syntax and options for other subcommands such as key, and ping, by replacing license with the respective subcommand.

To get a general overview of the available commands and their usage, use:

./appdcli -h

This displays the main help message, showing the available subcommands and their brief descriptions.

Subcommand Options

The following table lists the available subcommand options:


Option	Description
`-h, --help`	Show the help message and exit.

Arguments

The following table lists the available subcommand arguments. Use these arguments within curly brackets {}:


Arguments	Description
`controller`	Update Controller license.
`eum`	Update EUM license.

The secureapp task

The secureapp task requires one of the following options:


Option	Description
`checkAgentAuth`	Using the agent account key, verify that agent authentication is working.
`checkApi`	Checks that the Secure Application API is working.
`checkAuthToken`	Verify that the controller is able to create authentication tokens for the admin user.
`checkDeps`	Basic checks of Secure Application dependencies, useful prior to installation.
`debugReport`	Dump logs and kubernetes resources (except secrets) for offline debugging.
`getSecureApplications`	Gets the default for Application Secure Application enablement.
`health`	Run the `checkDeps` command, and additional Secure Application diagnostic tests for an overall health check.
`insecureApplications`	Administratively sets the default for Applications to be Secure Application disabled.
`licenseCheck`	Check that the license has Secure App Units.
`numAgentReports`	Display the number of Agent Reports that have been processed.
`restartFeedProcessing`	After uploading a data feed, to see updated results sooner than up to a day, restart the feed processing and see updates after a few minutes.
`secureApplications`	Administratively sets the default for Applications to be Secure Application enabled.
`setDownloadPortalCredentials`	For automatic daily downloads of the data feed. Set the download portal username and password. Syntax: `appdcli run secureapp setDownloadPortalCredentials <username>`
`setFeedKey`	For air-gapped deployments. Set the license key to allow processing of an uploaded air-gapped data feed. Syntax: `appdcli run secureapp setFeedKey <path to feed key or - to signify stdin>`
`showConfig`	Print currently observed Secure Application configuration.
`startTestAgent`	Launch a Java application named `test-agent` with active APM and Secure Application agents to verify agent registration, activity, and dependency reporting.
`stopTestAgent`	Stop the `test-agent` Java application.
`uploadFeed`	For air-gapped deployments. Upload an air-gapped data feed from the local filesystem. Syntax: `appdcli run secureapp uploadFeed <path to feed file>`
`versions`	Display version data, which may be useful during troubleshooting.

Documentation