Configuration Options for Machine Agent
This includes the custom configuration options for Machine Agent.
Install
Option | Description | Required | Note |
---|---|---|---|
--agent_version string | Set the AgentVersion. | No | N/A |
--analytics_event_endpoint string | Set the AnalyticsEventEndpoint. | No | N/A |
--application_name string | Set the ApplicationName. | No | N/A |
--autostart_agent | Set the AutostartAgent. | No | The default value is true . |
--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 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_global_analytics_account_name string | Set the ControllerGlobalAnalyticsAccountName. | No | N/A |
--controller_host_name string | Set the ControllerHostName. | Yes | If using proxy, set appropriate proxy values. |
--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. |
--dotnet_compatibility_mode string | Set the DotnetCompatibilityMode. | 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_analytics_agent string | Set the EnableAnalyticsAgent. | No | N/A |
--enable_orchestration string | Set the EnableOrchestration. | No | The default value is false . |
--enable_ssl | Set the ControllerEnableSSL. | No | N/A |
--group string | Set the Group. | No | N/A |
-h, --help | help for machine | No | |
--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 |
--java_system_properties string | Set the JavaSystemProperties. | No | N/A |
--keep_backup | Set the KeepBackup. | No | N/A |
--{os}_custom_agent_install_path string | Set the AgentCustomInstallPath. | No | Recommended. The Supported os types are linux and windows . If no value is provided, agent will install under <smart-agent-home-dir>/../machine-agent . |
--{os}_install_root string | Set the AppDDefaultInstallRoot. | No | The Supported os types are linux and windows . For example, linux_install_root
string. |
--machine_hierarchy string | Set the MachineHierarchy. | No | N/A |
--node_name string | Set the NodeName. | No | N/A |
--sim_enabled string | Set the SimEnabled. | No | The default value is false . |
--start_as_process | Set the StartAsProcessPtr. | 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 process. This directory gets cleaned up after the execution of the task. | No | N/A |
--tier_name string | Set the TierName. | No | |
--user string | Set the User. | No | N/A |
Uninstall
Option | Description | Required | Note |
---|---|---|---|
--agent_version string | Set the AgentVersion. | No | N/A |
--analytics_event_endpoint string | Set the AnalyticsEventEndpoint. | No | N/A |
--application_name string | Set the ApplicationName. | No | N/A |
--autostart_agent | Set the AutostartAgent. | No | The default value is true . |
--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_global_analytics_account_name string | Set the ControllerGlobalAnalyticsAccountName. | No | N/A |
--controller_host_name string | Set the ControllerHostName. | Yes | If using proxy, set appropriate proxy values. |
--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. |
--dotnet_compatibility_mode string | Set the DotnetCompatibilityMode. | 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_analytics_agent string | Set the EnableAnalyticsAgent. | No | N/A |
--enable_orchestration string | Set the EnableOrchestration. | No | The default value is false . |
--enable_ssl | Set the ControllerEnableSSL. | No | N/A |
--group string | Set the Group. | No | N/A |
-h, --help | help for machine | 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 |
--java_system_properties string | Set the JavaSystemProperties. | No | N/A |
--keep_backup | Set the KeepBackup. | No | N/A |
--{os}_custom_agent_install_path string | Set the AgentCustomInstallPath. | No | Recommended. The Supported os types are linux and windows . If no value is provided, agent will install under <smart-agent-home-dir>/../machine-agent . |
--{os}_install_root string | Set the AppDDefaultInstallRoot. | No | The Supported os types are linux and windows . For example, linux_install_root
string. |
--machine_hierarchy string | Set the MachineHierarchy. | No | N/A |
--node_name string | Set the NodeName. | No | N/A |
--sim_enabled string | Set the SimEnabled. | No | The default value is false . |
--start_as_process | Set the StartAsProcessPtr. | 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 |
--tier_name string | Set the TierName. | No | N/A |
--user string | Set the User. | No | N/A |
Upgrade
Option | Description | Required | Note |
---|---|---|---|
--agent_version string | Set the AgentVersion. | No | N/A |
--analytics_event_endpoint string | Set the AnalyticsEventEndpoint. | No | N/A |
--application_name string | Set the ApplicationName. | No | N/A |
--autostart_agent | Set the AutostartAgent. | No | The default value is true . |
--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_global_analytics_account_name string | Set the ControllerGlobalAnalyticsAccountName. | No | N/A |
--controller_host_name string | Set the ControllerHostName. | Yes | If using proxy, set appropriate proxy values. |
--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. |
--dotnet_compatibility_mode string | Set the DotnetCompatibilityMode. | 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_analytics_agent string | Set the EnableAnalyticsAgent. | No | N/A |
--enable_orchestration string | Set the EnableOrchestration. | No | The default value is false . |
--enable_ssl | Set the ControllerEnableSSL. | No | N/A |
--group string | Set the Group. | No | N/A |
-h, --help | help for machine | No | N/A |
--hostname string | Set the Hostname. | No | N/A |
--ini string | config file | No | default "config.ini" |
--install_agent_from string | Set the InstallAgentFrom. | No | N/A |
--java_system_properties string | Set the JavaSystemProperties. | No | N/A |
--keep_backup | Set the KeepBackup. | No | N/A |
--{os}_custom_agent_install_path string | Set the AgentCustomInstallPath. | No | Recommended. The Supported os types are linux and windows . If no value is provided, agent will install under <smart-agent-home-dir>/../machine-agent . |
--{os}_install_root string | Set the AppDDefaultInstallRoot. | No | The Supported os types are linux and windows . For example, linux_install_root
string. |
--machine_hierarchy string | Set the MachineHierarchy. | No | N/A |
--node_name string | Set the NodeName. | No | N/A |
--sim_enabled string | Set the SimEnabled. | No | The default value is false . |
--start_as_process | Set the StartAsProcessPtr. | 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 |
--tier_name string | Set the TierName. | No | N/A |
--user string | Set the User. | No | N/A |