Configuration Options for Java Agent

This includes the custom configuration options for Java Agent.

Install

Option Description Required Note
--user string Set the User. No N/A
--update_ld_preload Set the UpdateLdPreload. No The default value is true.
--tier_name string Set the TierName. No Recommended to set to the actual tier name.
--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
--reuse_config Set the ReuseConfig. No N/A
--node_name string Set the NodeName. No Recommended to set to the actual node name.
--{os}_install_root Set the AppDynamics default install root. No Here, os can be linux or windows. For example, linux_install_root.
--{os}_custom_agent_install_path string Set the agent custom install path. No

Here, os can be linux or windows.

This option is recommended. Supported operating system types are linux and windows. If not provided, agent will install under <smart-agent-home-dir>/../java-agent.
--keep_backup Set the Keep backup. No N/A
--java_system_properties string Set the Java System Properties. No N/A
--java_app_user Set the open up folder permission. No N/A
--java_agent_ssl_client_auth Set the Java Agent SSL client auth. No N/A
--java_agent_runtime_dir string Set the Java Agent runtime Directory. No N/A
--java_agent_is_simple_hostname Set the Java Agent IsSimpleHostname. No N/A
--java_agent_install_path string Set the JavaAgentInstallPath. No N/A
--java_agent_force_registration string Set the JavaAgentForceRegistration. No The default is false.
--java_agent_encrypted_creds string Set the JavaAgentEncryptedCreds. No N/A
--java_agent_enable_orchestration string Set the JavaAgentEnableOrchestration. No The default is false
--java_agent_dest_file string Set the JavaAgentDestFile. No The default value is java-agent.zip
--java_agent_credential_store_pass string Set the JavaAgentCredentialStorePass. No N/A
--java_agent_credential_store_format string Set the JavaAgentCredentialStoreFormat. No N/A
--java_agent_credential_store_file string Set the JavaAgentCredentialStoreFile. No N/A
--java_agent_backup_folder string Set the JavaAgentBackupPath. No N/A
--java_agent_auto_naming Set the JavaAgentAutoNaming. No N/A
--java_agent_assymetric_keystore_pass string Set the JavaAgentAsymmetricKeystorePass. No N/A
--java_agent_assymetric_keystore_name string Set the JavaAgentAsymmetricKeystoreName. No N/A
--java_agent_assymetric_key_pass string Set the JavaAgentAsymmetricKeyPass. No N/A
--java_agent_assymetric_key_alias string Set the JavaAgentAsymmetricKeyAlias. No N/A
--install_agent_from string Set the InstallAgentFrom. No N/A
--ini string config file No The default value is config.ini
--hostname string Set the Hostname. No N/A
-h, --help help for java No N/A
--group string Set the Group. No N/A
--enable_ssl Set the ControllerEnableSSL. No N/A
--download_uri string Set the DownloadURI. No The default value is https://download-files.appdynamics.com
--download_protocol string Set the DownloadProtocol. No The default value is appd.
--controller_port string Set the ControllerPort. Yes If not using proxy and enable_ssl is set to true, set controller_port=443.
--controller_host_name string Set the ControllerHostName. Yes If using proxy, set appropriate proxy values.
--controller_cert_file string Set the ControllerCertFile. No N/A
--controller_account_name string Set the ControllerAccountName. Yes N/A
--controller_account_access_key string Set the ControllerAccessKey. Yes 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 /opt/appdynamics/smartagent, the backup_dir path will be /opt/appdynamics/smartagent/backup.

 No N/A
--application_name string Set the ApplicationName. No Recommended to set to the actual application name.
--agent_version string Set the AgentVersion. No N/A

Uninstall

Command Description Required Note
Command Description Yes Note
--java_agent_force_registration string Set the JavaAgentForceRegistration. No The default value is false.
--java_agent_credential_store_pass string Set the JavaAgentCredentialStorePass. No N/A
--java_agent_credential_store_format string Set the JavaAgentCredentialStoreFormat. No N/A
--java_agent_credential_store_file string Set the JavaAgentCredentialStoreFile. No N/A
--java_agent_backup_folder string Set the JavaAgentBackupPath. No N/A
--java_agent_auto_naming Set the JavaAgentAutoNaming. No N/A
--java_agent_assymetric_keystore_pass string Set the JavaAgentAsymmetricKeystorePass. No N/A
--java_agent_assymetric_keystore_name string Set the JavaAgentAsymmetricKeystoreName. No N/A
--java_agent_assymetric_key_pass string Set the JavaAgentAsymmetricKeyPass. No N/A
--java_agent_assymetric_key_alias string Set the JavaAgentAsymmetricKeyAlias. No N/A
--install_agent_from string Set the InstallAgentFrom. No N/A
--ini string config file No The default value is config.ini.
--hostname string Set the Hostname. No N/A
-h, --help help for java No N/A
--group string Set the Group. No N/A
--enable_ssl Set the ControllerEnableSSL. No N/A
--download_uri string Set the DownloadURI. No The default value is https://download-files.appdynamics.com.
--download_protocol string Set the DownloadProtocol. No The default value is appd.
--controller_port string Set the ControllerPort. Yes If not using proxy and enable_ssl is set to true, set controller_port=443.
--controller_host_name string Set the ControllerHostName. Yes N/A
--controller_cert_file string Set the ControllerCertFile. No N/A
--controller_account_name string Set the ControllerAccountName. Yes N/A
--controller_account_access_key string Set the ControllerAccessKey. Yes N/A
--application_name string Set the ApplicationName. No N/A
--agent_version string Set the AgentVersion. No N/A
--java_agent_encrypted_creds string Set the JavaAgentEncryptedCreds. No N/A
--java_agent_enable_orchestration string Set the JavaAgentEnableOrchestration. No The default value is false.
--java_agent_dest_file string Set the JavaAgentDestFile. No The default value is java-agent.zip
--java_agent_credential_store_pass string Set the JavaAgentCredentialStorePass. No N/A
--java_agent_credential_store_format string Set the JavaAgentCredentialStoreFormat. No N/A
--java_agent_credential_store_file string Set the JavaAgentCredentialStoreFile. No N/A
--java_agent_backup_folder string Set the JavaAgentBackupPath. No N/A
--java_agent_auto_naming Set the JavaAgentAutoNaming. No N/A
--java_agent_assymetric_keystore_pass string Set the JavaAgentAsymmetricKeystorePass. No N/A
--java_agent_assymetric_keystore_name string Set the JavaAgentAsymmetricKeystoreName. No N/A
--java_agent_assymetric_key_pass string Set the JavaAgentAsymmetricKeyPass. No N/A
--java_agent_assymetric_key_alias string Set the JavaAgentAsymmetricKeyAlias. No N/A
--install_agent_from string Set the InstallAgentFrom. No N/A
--ini string config file No The default value is config.ini.
--hostname string Set the Hostname. No N/A
-h, --help help for java No N/A
--group string Set the Group. No N/A
--enable_ssl Set the ControllerEnableSSL. No N/A

Upgrade

Command Description Required Note
--user string Set the User. No N/A
--update_ld_preload Set the UpdateLdPreload. No The default value is true.
--tier_name string Set the TierName. No Recommended to set to the actual tier name.
--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
--reuse_config Set the ReuseConfig. No N/A
--node_name string Set the NodeName. No Recommended to set to the actual node name.
--{os}_install_root string Set the AppDDefaultInstallRoot. No Here, os can be linux or windows. For example, linux_install_root.
--{os}_custom_agent_install_path string Set the AgentCustomInstallPath. No

Here, os can be linux or windows.

This option is recommended. Supported operating system types are linux and windows. If not provided, agent will install under <smart-agent-home-dir>/../java-agent.
--preserve_config Preserve the configuration. No The default value is true. If you want to customize the agent configuration in Controller, set the value to false.
--keep_backup Set the KeepBackup. No N/A
--java_system_properties string Set the JavaSystemProperties. No N/A
--java_app_user Set the OpenUpFolderPermission. No N/A
--java_agent_ssl_client_auth Set the JavaAgentSSLClientAuth. No N/A
--java_agent_runtime_dir string Set the JavaAgentRuntimeDir. No N/A
--java_agent_is_simple_hostname Set the JavaAgentIsSimpleHostname. No N/A
--java_agent_install_path string Set the JavaAgentInstallPath. No N/A
--java_agent_force_registration string Set the JavaAgentForceRegistration. No The default value is false.
--java_agent_encrypted_creds string Set the JavaAgentEncryptedCreds. No N/A
--java_agent_enable_orchestration string Set the JavaAgentEnableOrchestration. No The default value is false.
--java_agent_dest_file string Set the JavaAgentDestFile. No The default value is java-agent.zip
--java_agent_credential_store_pass string Set the JavaAgentCredentialStorePass. No N/A
--java_agent_credential_store_format string Set the JavaAgentCredentialStoreFormat. No N/A
--java_agent_credential_store_file string Set the JavaAgentCredentialStoreFile. No N/A
--java_agent_backup_folder string Set the JavaAgentBackupPath. No N/A
--java_agent_auto_naming Set the JavaAgentAutoNaming. No N/A
--java_agent_assymetric_keystore_pass string Set the JavaAgentAsymmetricKeystorePass. No N/A
--java_agent_assymetric_keystore_name string Set the JavaAgentAsymmetricKeystoreName. No N/A
--java_agent_assymetric_key_pass string Set the JavaAgentAsymmetricKeyPass. No N/A
--java_agent_assymetric_key_alias string Set the JavaAgentAsymmetricKeyAlias. No N/A
--install_agent_from string Set the InstallAgentFrom. No N/A
--ini string config file No The default value is config.ini
--hostname string Set the Hostname. No N/A
-h, --help help for java No N/A
--group string Set the Group. No N/A
--enable_ssl Set the ControllerEnableSSL. No N/A
--download_uri string Set the DownloadURI. No The default value is https://download-files.appdynamics.com.
--download_protocol string Set the DownloadProtocol. No The default value is appd.
--controller_port string Set the ControllerPort. Yes If not using proxy and enable_ssl is set to true, set controller_port=443.
--controller_host_name string Set the ControllerHostName. Yes N/A
--controller_cert_file string Set the ControllerCertFile. No N/A
--controller_account_name string Set the ControllerAccountName. Yes N/A
--controller_account_access_key string Set the ControllerAccessKey. Yes 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 /opt/appdynamics/smartagent, the backup_dir path will be /opt/appdynamics/smartagent/backup.

 No N/A
--application_name string Set the ApplicationName. No Recommended to set to the actual application name.
--agent_version string Set the AgentVersion. No N/A