Menu
AWS Application Discovery Service
User Guide

Set up AWS Application Discovery Agents

The AWS Application Discovery Agent is AWS software that you install on on-premises servers and virtual machines (VMs) that you can target for discovery and migration. Agents run on Linux and Windows servers and collect configuration and activity information about your applications and infrastructure. Agents send this data to Application Discovery Service using Secure Sockets Layer (SSL) encryption. Several minutes after you instruct agents to start collecting data, Application Discovery Service receives the data and begins to process connections and discover dependencies. Discovered IT assets are called configuration items. For more information about the AWS Application Discovery Agent, see AWS Application Discovery Service Components.

Before You Begin

If you installed a Linux preview version of the AWS Application Discovery Agent, you must uninstall it or you won't be able to install the current version. This does not apply to the agent for Windows. Use the following command to download the removal script to your Linux instance or server:

Copy
curl -O https://d1wk0tztpsntt1.cloudfront.net/linux/latest/remove_preview_agent

To remove the preview agent, run the following command:

Copy
sudo ./remove_preview_agent

Installing the AWS Application Discovery Agent

Work with application owners to identify the IP address or DNS name of at least one of the server or VM workloads hosting the application in an on-premises data center. With the help of the application's operations team, install an AWS Application Discovery Agent within that workload. The agent identifies the servers or VMs that communicate with the workload and report the data to Application Discovery Service. You can then install agents on one or more of these servers to discover their dependencies. Iterate through this process until you have discovered all of the application dependencies.

Important

Only certified AWS partners can download the installer from the Amazon Partner Network. If you are an AWS partner who wants to join the list of certified partners, contact the Application Discovery Service team through the APN program.

On-Premises Installation for Microsoft Windows

Use the following procedure to install an AWS Application Discovery Agent on a Windows-based VM or server in your data center.

To install the AWS Application Discovery Agent in your data center

  1. Download the agent installer to a host server or VM.

  2. Open a command prompt as an administrator and navigate to the location where you saved the installation package.

  3. To install the agent, run the following command:

    Copy
    DiscoveryAgentInstall.exe REGION=us-west-2

    Note

    The AWS Application Discovery Agent automatically downloads and applies updates as they become available. If you don't want agents to download and apply updates automatically, then run the following command when you install the agent:

    Copy
    DiscoveryAgentInstall.exe REGION=us-west-2 AUTOUPDATE=No
  4. Open the %SystemRoot%\system32\config\systemprofile\.aws\credentials file and specify your AWS credentials. If you do not locate the file, you must create it. Specify credentials in the following format:

    Copy
    [default] aws_access_key_id=AKIAIOSFODNN7EXAMPLE aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

    Note

    The IAM policy attached to your AWS account must have access to Application Discovery Service resources. For more information, see Attach Required IAM User Policies.

  5. Update your firewall settings. The AWS Application Discovery Agent requires outbound access to arsenal.us-west-2.amazonaws.com:443. It does not require any inbound ports to be open. Agents also work with transparent web proxies.

Use the following procedure to verify the agent installation.

To verify that the AWS Application Discovery Agent is running

  1. On the EC2 instance where you installed the AWS Application Discovery Agent, open a command prompt with administrator permissions and navigate to C:/Program Files/Amazon Web Services/Aws Agent.

  2. Run the following command:

    Copy
    AWSAgentStatus.exe

    This command returns the status of the currently running agent, or an error stating that the agent cannot be contacted.

To start or stop an AWS Application Discovery Agent, use Windows Services Manager to start or stop the AWS Agent service and the AWS Agent Updater service. To uninstall an agent, use Add/Remove Programs to remove these services.

On-Premises Installation for Linux

Use the following procedure to install an AWS Application Discovery Agent on a Linux-based VM or server in your data center.

To install the AWS Application Discovery Agent in your data center

  1. Log on to the Linux-based server or VM and open the AWS CLI.

  2. Open the ~/.aws/credentials file and specify your AWS credentials:

    Copy
    [default] aws_access_key_id=AKIAIOSFODNN7EXAMPLE aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

    Note

    The IAM policy attached to your AWS account must have access to Application Discovery Service resources. For more information, see Attach Required IAM User Policies.

  3. Download the agent installer to a host server or VM.

  4. Open the /opt/aws/awsagent/etc/agent.cfg file and verify that the endpoint is (arsenal.us-west-2.amazonaws.com) and the region is (us-west-2).

  5. Run the following command to install the agent in the us-west-2 region:

    Copy
    sudo bash install -r us-west-2

    Note

    Agents automatically download and apply updates as they become available. If you don't want agents to download and apply updates automatically, then run the following command when you install the agent:

    Copy
    sudo bash install -u false
  6. After the installation completes, use the following command to remove the agent installation script:

    Copy
    rm install
  7. Update your firewall settings. The AWS Application Discovery Agent requires outbound access to arsenal.us-west-2.amazonaws.com:443. It does not require any inbound ports to be open. Agents also work with transparent web proxies.

The following table lists commands that you can use to manage or uninstall agents.

Linux Commands for AWS Application Discovery Agents

Task Command
Start an agent sudo /etc/init.d/awsagent start
Verify that an agent is running sudo /opt/aws/awsagent/bin/awsagent status
Stop an agent sudo /etc/init.d/awsagent stop
Restart an agent sudo /etc/init.d/awsagent restart
Uninstall an agent from Amazon Linux, CentOS, or Red Hat yum remove AwsAgent
Uninstall an agent from Ubuntu Server apt-get remove awsagent

After agent installation is complete, you can use the console or API to manage your discovery agents, tag and query configuration items, and export data. You can export data as a CSV file to an Amazon S3 bucket or an application that enables you to view and evaluate the data. For more information, see Tutorial: Using the AWS Application Discovery Service Console or the Application Discovery Service API Reference.