Configuration Options for Database Agent
This includes the custom configuration options for Database Agent.
Install
Option | Description | Required | Note |
---|---|---|---|
--agent_name string | Set the Agent name. | No | N/A |
--agent_pid string | Set the Agent Pid. | No | N/A |
--agent_version string | Set the Agent version. | No | N/A |
--asymmetric_key_alias string | Set the Asymmetric Key Alias. | No | N/A |
--asymmetric_key_password string | Set the Asymmetric Key Password. | No | N/A |
--asymmetric_keystore_filename string | Set the Asymmetric Keystore Filename. | No | N/A |
--asymmetric_keystore_password string | Set the Asymmetric Keystore Password. | No | N/A |
--backup_dir string | The 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 | No | N/A |
--controller_account_access_key string | Set the Controller Access Key. | Yes | N/A |
--controller_account_name string | Set the Controller Account Name. | Yes | N/A |
--controller_cert_file string | Set the Controller Cert File. | No | N/A |
--controller_host_name string | Set the Controller Hostname. | Yes | If using proxy, set appropriate proxy values. |
--controller_keystore_filename string | Set the Controller Keystore filename. | No | N/A |
--controller_keystore_password string | Set the ControllerKeystorePassword. | No | N/A |
--controller_port string | Set the ControllerPort. | Yes | If not using proxy and enable_ssl is set to true, set controller_port=443 . If using proxy, set appropriate proxy values. |
--credential_storeFilename string | Set the CredentialStoreFilename. | No | N/A |
--credential_store_format string | Set the CredentialStoreFormat. | No | N/A |
--credential_store_password string | Set the CredentialStorePassword. | No | N/A |
--download_protocol string | Set the DownloadProtocol. | No | The default value is appd. |
--download_uri string | Set the DownloadURI. | No | The default value is https://download-files.appdynamics.com. |
--enable_ssl | Set the ControllerEnableSSL. | No | N/A |
--flags string | Set the Flags. | No | Recommended with value of dbagent.name=<name-here> . If name is not provided, agent will be given a random string. |
--group string | Set the Group. | No | N/A |
-h, --help | help for db | No | N/A |
--hostname string | Set the Hostname. | No | N/A |
--ini string | config file | No | The default value is config.ini . |
--install_agent_from string | Set the InstallAgentFrom. | No | N/A |
--install_as_service | Set the InstallAsService. | No | N/A |
--jvm_options string | Set the JVMOptions. | No | N/A |
--jvm_options_override | Set the JVMOptionsOverride. | No | N/A |
--keep_backup | Set the KeepBackup. | No | N/A |
--linux_custom_agent_install_path string | Set the AgentCustomInstallPath. | No | Recommended. If not provided, agent will install under <smart-agent-home-dir>/../db-agent . |
--linux_install_root string | Set the AppDDefaultInstallRoot. | No | N/A |
--temp_dir string | Set 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. | No | N/A |
--use_encrypted_credentials | Set the UseEncryptedCredentials. | No | N/A |
--use_ssl_client_auth | Set the UseSslClientAuth. | No | N/A |
--user string | Set the User. | No | N/A |
Uninstall
Option | Description | Required | Note |
---|---|---|---|
--agent_name string | Set the AgentName. | No | N/A |
--agent_pid string | Set the AgentPid. | No | N/A |
--agent_version string | Set the AgentVersion. | No | N/A |
--asymmetric_key_alias string | Set the AsymmetricKeyAlias. | No | N/A |
--asymmetric_key_password string | Set the AsymmetricKeyPassword. | No | N/A |
--asymmetric_keystore_filename string | Set the AsymmetricKeystoreFilename. | No | N/A |
--asymmetric_keystore_password string | Set the AsymmetricKeystorePassword. | No | N/A |
--backup_dir string | The 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 | Yes | N/A |
--controller_account_access_key string | Set the ControllerAccessKey. | Yes | N/A |
--controller_account_name string | Set the ControllerAccountName. | Yes | N/A |
--controller_cert_file string | Set the ControllerCertFile. | No | N/A |
--controller_host_name string | Set the ControllerHostName. | Yes | If using proxy, set appropriate proxy values. |
--controller_keystore_filename string | Set the ControllerKeystoreFilename. | No | N/A |
--controller_keystore_password string | Set the ControllerKeystorePassword. | No | N/A |
--controller_port string | Set the ControllerPort. | Yes | If not using proxy and enable_ssl is set to true, set controller_port=443 . If using proxy, set appropriate proxy values. |
--credential_storeFilename string | Set the CredentialStoreFilename. | No | N/A |
--credential_store_format string | Set the CredentialStoreFormat. | No | N/A |
--credential_store_password string | Set the CredentialStorePassword. | No | N/A |
--download_protocol string | Set the DownloadProtocol. | No | The default value is appd . |
--download_uri string | Set the DownloadURI. | No | The default value is https://download-files.appdynamics.com |
--enable_ssl | Set the ControllerEnableSSL. | No | N/A |
--flags string | Set the Flags. | No | N/A |
--group string | Set the Group. | No | N/A |
-h, --help | help for db | No | N/A |
--hostname string | Set the Hostname. | No | N/A |
--ini string | config file | No | The default value is config.ini . |
--install_agent_from string | Set the InstallAgentFrom. | No | N/A |
--install_as_service | Set the InstallAsService. | No | N/A |
--jvm_options string | Set the JVMOptions. | No | N/A |
--jvm_options_override | Set the JVMOptionsOverride. | No | N/A |
--keep_backup | Set the KeepBackup. | No | N/A |
--linux_custom_agent_install_path string | Set the AgentCustomInstallPath. | No | Recommended. If not provided, agent will install under <smart-agent-home-dir>/../db-agent . |
--linux_install_root string | Set the AppDDefaultInstallRoot. | No | N/A |
--temp_dir string | Set 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. | No | N/A |
--use_encrypted_credentials | Set the UseEncryptedCredentials. | No | N/A |
--use_ssl_client_auth | Set the UseSslClientAuth. | No | N/A |
--user string | Set the User. | No | N/A |
Upgrade
Option | Description | Required | Note |
---|---|---|---|
--agent_name string | Set the AgentName. | No | N/A |
--agent_pid string | Set the AgentPid. | No | N/A |
--agent_version string | Set the AgentVersion. | No | N/A |
--asymmetric_key_alias string | Set the AsymmetricKeyAlias. | No | N/A |
--asymmetric_key_password string | Set the AsymmetricKeyPassword. | No | N/A |
--asymmetric_keystore_filename string | Set the AsymmetricKeystoreFilename. | No | N/A |
--asymmetric_keystore_password string | Set the AsymmetricKeystorePassword. | No | N/A |
--backup_dir string | Set the AgentBackupDir. | Yes | N/A |
--controller_account_access_key string | Set the ControllerAccessKey. | Yes | N/A |
--controller_account_name string | Set the ControllerAccountName. | Yes | N/A |
--controller_cert_file string | Set the ControllerCertFile. | No | N/A |
--controller_host_name string | Set the ControllerHostName. | Yes | If using proxy, set appropriate proxy values. |
--controller_keystore_filename string | Set the ControllerKeystoreFilename. | No | N/A |
--controller_keystore_password string | Set the ControllerKeystorePassword. | No | N/A |
--controller_port string | Set the ControllerPort. | Yes | N/A |
--credential_storeFilename string | Set the CredentialStoreFilename. | No | N/A |
--credential_store_format string | Set the CredentialStoreFormat. | No | N/A |
--credential_store_password string | Set the CredentialStorePassword. | No | N/A |
--download_protocol string | Set the DownloadProtocol. | No | The default value is appd . |
--download_uri string | Set the DownloadURI. | No | The default value is https://download-files.appdynamics.com. |
--enable_ssl | Set the ControllerEnableSSL. | No | N/A |
--flags string | Set the Flags. | No | Recommended with value of dbagent.name=<name-here> . If name is not provided, agent will be given a random string. |
--group string | Set the Group. | No | N/A |
-h, --help | help for db | No | N/A |
--hostname string | Set the Hostname. | No | N/A |
--ini string | config file | No | The default value is config.ini . |
--install_agent_from string | Set the InstallAgentFrom. | No | N/A |
--install_as_service | Set the InstallAsService. | No | N/A |
--jvm_options string | Set the JVMOptions. | No | N/A |
--jvm_options_override | Set the JVMOptionsOverride. | No | N/A |
--keep_backup | Set the KeepBackup. | No | N/A |
--linux_custom_agent_install_path string | Set the AgentCustomInstallPath. | No | Recommended. If not provided, agent will install under <smart-agent-home-dir>/../db-agent . |
--linux_install_root string | Set the AppDDefaultInstallRoot. | No | N/A |
--temp_dir string | Set 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. | No | N/A |
--use_encrypted_credentials | Set the UseEncryptedCredentials. | No | N/A |
--use_ssl_client_auth | Set the UseSslClientAuth. | No | N/A |
--user string | Set the User. | No | N/A |