TheEnterprise Panelcommand line utility allows you lot to perform orchestration tasks in an automated way. Information technology is designed with the following limitations in heed:

  • In that location is not a complete friction match of all the functionalities provided by the web UI.
  • The command line utility is just supported to run on the host where the Enterprise Panel is installed.

Control Line Directory

The platform-admin.sh|bat script in the<Enterprise Console home>/platform-admin/bin directory on the host automobile provides a ready of commands to install and manage the AppDynamics platform.

To meet the operations available for theEnterprise Console, from the command line, navigate to directory and run the script with -h specified: 

              bin/platform-admin.sh -h

Bash 

              bin\platform-admin.exe cli -h

BASH

And you can view the format for each control in the command line by specifying the -h argument for a specific command: 

              bin/platform-admin.sh <command> -h

Bash 

              bin\platform-admin.exe cli <command> -h

Bash

You can also usebin/platform-admin.sh list-jobs --service <controller or events-service> to meet a listing of jobs available for the provided service. You can then run across what parameters are required for the provided task usingbin/platform-admin.sh list-job-parameters --chore <job_name> --service <controller or events-service>.

Not all commands available on Linux are available on Windows. Refer to the list of the Enterprise Console commands displayed with the -h parameter.

TheEnterprise Panel prevents multiple users from running commands at the same time. If a second user attempts to run a command while some other command is in progress, the second control is not completed and an error message appears indicating that another command is in progress. To avoid such conflicts, the Enterprise Panel should generally be used by a single user at a fourth dimension.

Logging into and out of theEnterprise Console

Commands for logging in and out of theEnterprise Panel are:

  • login --user-name <admin_username> --countersign <admin_password>
    If it has been more than one twenty-four hours since your last session, you lot volition have to log in earlier you are able to use the command line utility. You will besides have to log in again if you see the following fault message:

    mistake: Command failed due to an error: Unauthorized API lawmaking 401 Session expired. Delight login and run the control again.
  • logout

Managing the Password of the Enterprise Console

Commands for resetting or changing yourEnterprise Console password are:

  • reset-password
    If you forget your admin password or encounter a 401 error, run this control to reset your password to its default value,admin. Yous will need to log out then log dorsum in for this alter to take issue.
  • change-countersign --user-name <username> --countersign <old_password> --new-password <new_password>

Starting and Stopping theEnterprise Console

Just as you can first and stop the Controller and Events Service, you tin can start and end theEnterprise Console process. Commands for starting and stopping theEnterprise Panel are:

  • start-platform-admin
  • end-platform-admin

TheEnterprise Console must be running to install or administrate Events Service nodes.

Getting Platform Versions

You can get the version of the Enterprise Panel and whatsoever other components that you installed with the Enterprise Console.

To go the version of the Enterprise Console: 

              bin/platform-admin.sh show-platform-admin-version

BASH 

              bin\platform-admin.exe cli show-platform-admin-version

BASH

To go the version of one of the platform components: 

              bin/platform-admin.sh become-bachelor-versions --platform-name <platform-proper name> --service <controller or events-service>

Bash 

              bin\platform-admin.exe cli get-bachelor-versions --platform-name <platform-proper name> --service <controller or events-service>

Fustigate

Setting the Current Platform

The optional parameter, --platform-proper noun, can be passed in each of your commands to prepare the electric current working platform. However, yous tin ready the environs variable, APPD_CURRENT_PLATFORM, so that you practise not have to pass the electric current working parameter with each of your commands. You tin fix this variable using setenv or export. The Enterprise Console volition pick upwardly the value if it is present.

If you happen to provide the --platform-name parameter while APPD_CURRENT_PLATFORM is set up, the value passed through the flag will override the environment variable.

All Platforms Flag

Y'all can use the--all flag to denote that yous want to modify all platforms with your control. For example, you can upgrade all platform binaries at once past running the following command: 

              bin/platform-admin.sh upgrade-orcha --all

Fustigate 

              bin\platform-admin.exe cli upgrade-orcha --all

BASH

AdditionalEnterprise Console Commands

The following is a list of frequently used Enterprise Console commands:

  • create-platform --name <platform_name> --description <description> --installation-dir <install_dir>

  • delete-platform --name <platform_name>
  • upgrade-orcha --platform-name <platform_name>
    This command triggers an upgrade of the Orcha module binaries on all remote Orcha machines in the provided platform. The platform should non be running any jobs on its services when y'all run this control.
  • list-supported-services
  • show-platform-admin-version