仮想アプライアンス CLI

仮想アプライアンスのコマンド ライン ユーティリティ（CLI）は、ライセンスの適用、ポッドステータスの表示などのタスクを実行できるサービスです。このユーティリティは、仮想アプライアンスパッケージにバンドルされています。

構文

appdcli コマンドは階層構造になっています。メインコマンドの後にサブコマンドが続きます。サブコマンドには、実行できる特定のタスクを表す他のさまざまなサブコマンドがあります。仮想アプライアンスのタスクを実行するために使用できるコマンドの構文を次に示します。

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:

SubcommandUsage
start

Start Splunk AppDynamics, Anomaly Detection, and Secure Application services.

sync

Synchronize services.

pingDisplay the ping status.
license

Update or apply the license.

To use a MAC address-based license on a specific node in the cluster, first set appdController.nodeLocked to true in the global.yaml.gotmpl file. After that, update or apply the license. See Edit the global.yaml.gotmpl.

keyUpdate 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:

OptionDescription
-h, --helpShow the help message and exit.

Arguments

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

ArgumentsDescription
controllerUpdate Controller license.
eumUpdate EUM license.

The secureapp Task

The secureapp task requires one of the following options:

OptionDescription
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.