Configuration Options for Database Agent

This includes the custom configuration options for Database Agent.

Install

OptionDescriptionRequiredNote
--agent_name stringSet the Agent name.NoN/A
--agent_pid stringSet the Agent Pid.NoN/A
--agent_version stringSet the Agent version.NoN/A
--asymmetric_key_alias stringSet the Asymmetric Key Alias.NoN/A
--asymmetric_key_password stringSet the Asymmetric Key Password.NoN/A
--asymmetric_keystore_filename stringSet the Asymmetric Keystore Filename.NoN/A
--asymmetric_keystore_password stringSet the Asymmetric Keystore Password.NoN/A
--backup_dir stringThe agent backup directory.

This is used for saving the current directory of the agent to preserve and use during rollback.

The default value is the parent directory of the Smart Agent. For example,

If Smart Agent path is /opt/appdynamics/smartagent, the backup_dir path will be /opt/appdynamics/smartagent/backup.

NoN/A
--controller_account_access_key stringSet the Controller Access Key. YesN/A
--controller_account_name stringSet the Controller Account Name.YesN/A
--controller_cert_file stringSet the Controller Cert File.NoN/A
--controller_host_name stringSet the Controller Hostname. YesIf using proxy, set appropriate proxy values.
--controller_keystore_filename stringSet the Controller Keystore filename.NoN/A
--controller_keystore_password stringSet the ControllerKeystorePassword.NoN/A
--controller_port stringSet the ControllerPort. YesIf not using proxy and enable_ssl is set to true, set controller_port=443. If using proxy, set appropriate proxy values.
--credential_storeFilename stringSet the CredentialStoreFilename.NoN/A
--credential_store_format stringSet the CredentialStoreFormat.NoN/A
--credential_store_password stringSet the CredentialStorePassword.NoN/A
--download_protocol stringSet the DownloadProtocol. NoThe default value is appd.
--download_uri stringSet the DownloadURI. NoThe default value is https://download-files.appdynamics.com.
--enable_sslSet the ControllerEnableSSL.NoN/A
--flags stringSet the Flags.NoRecommended with value of dbagent.name=<name-here>. If name is not provided, agent will be given a random string.
--group stringSet the Group.NoN/A
-h, --helphelp for dbNoN/A
--hostname stringSet the Hostname.NoN/A
--ini stringconfig file NoThe default value is config.ini.
--install_agent_from stringSet the InstallAgentFrom.NoN/A
--install_as_serviceSet the InstallAsService.NoN/A
--jvm_options stringSet the JVMOptions.NoN/A
--jvm_options_overrideSet the JVMOptionsOverride.NoN/A
--keep_backupSet the KeepBackup.NoN/A
--linux_custom_agent_install_path stringSet the AgentCustomInstallPath.NoRecommended. If not provided, agent will install under <smart-agent-home-dir>/../db-agent.
--linux_install_root stringSet the AppDDefaultInstallRoot.NoN/A
--temp_dir stringSet the temporary directory. The default value is the temporary directory of the operating system. For example, /tmp for linux operating system. This is used to perform the tasks such as downloading the agent, unzipping the artifacts, during the install or upgrade process. This directory gets cleaned up after the execution of the task.NoN/A
--use_encrypted_credentialsSet the UseEncryptedCredentials.NoN/A
--use_ssl_client_authSet the UseSslClientAuth.NoN/A
--user stringSet the User.NoN/A

Uninstall

OptionDescriptionRequiredNote
--agent_name stringSet the AgentName.NoN/A
--agent_pid stringSet the AgentPid.NoN/A
--agent_version stringSet the AgentVersion.NoN/A
--asymmetric_key_alias stringSet the AsymmetricKeyAlias.NoN/A
--asymmetric_key_password stringSet the AsymmetricKeyPassword.NoN/A
--asymmetric_keystore_filename stringSet the AsymmetricKeystoreFilename.NoN/A
--asymmetric_keystore_password stringSet the AsymmetricKeystorePassword.NoN/A
--backup_dir stringThe agent backup directory.

This is used for saving the current directory of the agent to preserve and use during rollback.

The default value is the parent directory of the Smart Agent. For example,

If Smart Agent path is /opt/appdynamics/smartagent, the backup_dir path will be /opt/appdynamics/smartagent/backup.

YesN/A
--controller_account_access_key stringSet the ControllerAccessKey.YesN/A
--controller_account_name stringSet the ControllerAccountName.YesN/A
--controller_cert_file stringSet the ControllerCertFile.NoN/A
--controller_host_name stringSet the ControllerHostName.YesIf using proxy, set appropriate proxy values.
--controller_keystore_filename stringSet the ControllerKeystoreFilename.NoN/A
--controller_keystore_password stringSet the ControllerKeystorePassword.NoN/A
--controller_port stringSet the ControllerPort.YesIf not using proxy and enable_ssl is set to true, set controller_port=443. If using proxy, set appropriate proxy values.
--credential_storeFilename stringSet the CredentialStoreFilename.NoN/A
--credential_store_format stringSet the CredentialStoreFormat.NoN/A
--credential_store_password stringSet the CredentialStorePassword.NoN/A
--download_protocol stringSet the DownloadProtocol. NoThe default value is appd.
--download_uri stringSet the DownloadURI. NoThe default value is https://download-files.appdynamics.com
--enable_sslSet the ControllerEnableSSL.NoN/A
--flags stringSet the Flags.NoN/A
--group stringSet the Group.NoN/A
-h, --helphelp for dbNoN/A
--hostname stringSet the Hostname.NoN/A
--ini stringconfig file NoThe default value is config.ini.
--install_agent_from stringSet the InstallAgentFrom.NoN/A
--install_as_serviceSet the InstallAsService.NoN/A
--jvm_options stringSet the JVMOptions.NoN/A
--jvm_options_overrideSet the JVMOptionsOverride.NoN/A
--keep_backupSet the KeepBackup.NoN/A
--linux_custom_agent_install_path stringSet the AgentCustomInstallPath.NoRecommended. If not provided, agent will install under <smart-agent-home-dir>/../db-agent.
--linux_install_root stringSet the AppDDefaultInstallRoot.NoN/A
--temp_dir stringSet the temporary directory. The default value is the temporary directory of the operating system. For example, /tmp for linux operating system. This is used to perform the tasks such as downloading the agent, unzipping the artifacts, during the install or upgrade process. This directory gets cleaned up after the execution of the task.NoN/A
--use_encrypted_credentialsSet the UseEncryptedCredentials.NoN/A
--use_ssl_client_authSet the UseSslClientAuth.NoN/A
--user stringSet the User.NoN/A

Upgrade

OptionDescriptionRequiredNote
--agent_name stringSet the AgentName.NoN/A
--agent_pid stringSet the AgentPid.NoN/A
--agent_version stringSet the AgentVersion.NoN/A
--asymmetric_key_alias stringSet the AsymmetricKeyAlias.NoN/A
--asymmetric_key_password stringSet the AsymmetricKeyPassword.NoN/A
--asymmetric_keystore_filename stringSet the AsymmetricKeystoreFilename.NoN/A
--asymmetric_keystore_password stringSet the AsymmetricKeystorePassword.NoN/A
--backup_dir stringSet the AgentBackupDir.YesN/A
--controller_account_access_key stringSet the ControllerAccessKey.YesN/A
--controller_account_name stringSet the ControllerAccountName.YesN/A
--controller_cert_file stringSet the ControllerCertFile.NoN/A
--controller_host_name stringSet the ControllerHostName.YesIf using proxy, set appropriate proxy values.
--controller_keystore_filename stringSet the ControllerKeystoreFilename.NoN/A
--controller_keystore_password stringSet the ControllerKeystorePassword.NoN/A
--controller_port stringSet the ControllerPort.YesN/A
--credential_storeFilename stringSet the CredentialStoreFilename.NoN/A
--credential_store_format stringSet the CredentialStoreFormat.NoN/A
--credential_store_password stringSet the CredentialStorePassword.NoN/A
--download_protocol stringSet the DownloadProtocol. NoThe default value is appd.
--download_uri stringSet the DownloadURI. NoThe default value is https://download-files.appdynamics.com.
--enable_sslSet the ControllerEnableSSL.NoN/A
--flags stringSet the Flags.NoRecommended with value of dbagent.name=<name-here>. If name is not provided, agent will be given a random string.
--group stringSet the Group.NoN/A
-h, --helphelp for dbNoN/A
--hostname stringSet the Hostname.NoN/A
--ini stringconfig file NoThe default value is config.ini.
--install_agent_from stringSet the InstallAgentFrom.NoN/A
--install_as_serviceSet the InstallAsService.NoN/A
--jvm_options stringSet the JVMOptions.NoN/A
--jvm_options_overrideSet the JVMOptionsOverride.NoN/A
--keep_backupSet the KeepBackup.NoN/A
--linux_custom_agent_install_path stringSet the AgentCustomInstallPath.NoRecommended. If not provided, agent will install under <smart-agent-home-dir>/../db-agent.
--linux_install_root stringSet the AppDDefaultInstallRoot.NoN/A
--temp_dir stringSet the temporary directory. The default value is the temporary directory of the operating system. For example, /tmp for linux operating system. This is used to perform the tasks such as downloading the agent, unzipping the artifacts, during the install or upgrade process. This directory gets cleaned up after the execution of the task.NoN/A
--use_encrypted_credentialsSet the UseEncryptedCredentials.NoN/A
--use_ssl_client_authSet the UseSslClientAuth.NoN/A
--user stringSet the User.NoN/A