Configuring Your Agent on the VM Local Console - AWS DataSync

Configuring Your Agent on the VM Local Console

For a DataSync setup that is deployed on-premises, you can perform the following maintenance tasks using the VM host's local console.

Logging In to the AWS DataSync Local Console

When the VM is ready for you to log in, the login screen is displayed. If this is your first time logging in to the local console, you use the default user name and password to log in. These default login credentials give you access to menus where you can configure the agent's network settings and change the password from the local console. You don't need to know the default password to set a new password.

For security reasons, you can't ssh to the agent or remotely connect to it.

To log in to the agent's local console

  • If this is your first time logging in to the local console, log in to the agent VM with the default credentials. The default user name is admin and the password is password. Otherwise, use your credentials to log in.

    Note

    We recommend changing the default password. You do this by running the passwd command from the local console menu (item 6 on the main menu). For information about how to run the command, see Running AWS DataSync Commands on the Local Console.

Configuring Your Agent Network Settings

The default network configuration for the agent is Dynamic Host Configuration Protocol (DHCP). With DHCP, your agent is automatically assigned an IP address. In some cases, you might need to manually assign your agent's IP as a static IP address, as described following.

To configure your agent to use static IP addresses

  1. Log in to your agent's local console:

  2. On the AWS Appliance Activation - Configuration main menu, enter 2 to begin configuring your network.

  3. On the Network Configuration menu, choose one of the following options.

    To Do This
    Get information about your network adapter

    Enter 1.

    A list of adapter names appears, and you are prompted to enter an adapter name—for example, eth0. If the adapter you specify is in use, the following information about the adapter is displayed:

    • Media access control (MAC) address

    • IP address

    • Netmask

    • Agent IP address

    • DHCP enabled status

    You use the same adapter name when you configure a static IP address (option 3) as when you set your agent's default route adapter (option 5).

    Configure DHCP

    Enter 2.

    You are prompted to configure the network interface to use DHCP.

    Configure a static IP address for your agent

    Enter 3.

    You are prompted to enter the Network adapter name.

    Important

    If your agent has already been activated, you must shut it down and restart it from the DataSync console for the settings to take effect.

    Reset all your agent's network configuration to DHCP

    Enter 4.

    All network interfaces are set to use DHCP.

    Important

    If your agent has already been activated, you must shut down and restart your agent from the DataSync console for the settings to take effect.

    Set your agent's default route adapter

    Enter 5.

    The available adapters for your agent are shown, and you are prompted to choose one of the adapters—for example, eth0.

    Edit your agent's DNS configuration

    Enter 6.

    The available adapters of the primary and secondary DNS servers are displayed. You are prompted to provide the new IP address.
    View your agent's DNS configuration

    Enter 7.

    The available adapters of the primary and secondary DNS servers are displayed.

    Note

    For some versions of the VMware hypervisor, you can edit the adapter configuration in this menu.

    View routing tables

    Enter 8.

    The default route of your agent is displayed.

Testing Your Agent Connection to the Internet

You can use your agent's local console to test your internet connection. This test can be useful when you are troubleshooting network issues with your agent.

To test your agent's connection to the internet

  1. Log in to your agent's local console:

  2. On the AWS Appliance Activation - Configuration main menu, enter 3 to begin testing network connectivity.

  3. Choose option 3 for DataSync.

    The console displays the available AWS Regions for DataSync.

  4. Choose the AWS Region that you want to test. For information about AWS Regions and endpoints, See AWS Regions and Endpoints.

    Each endpoint in the selected AWS Region displays either a PASSED or FAILED message, as shown following.

    Message Description
    [ PASSED ] DataSync has internet connectivity.
    [ FAILED ] DataSync doesn't have internet connectivity.

For information about network and firewall requirements, see Network Requirements for DataSync.

Viewing Your Agent System Resource Status

When your agent starts, it checks its virtual CPU cores, root volume size, and RAM. It then determines whether these system resources are sufficient for your agent to function properly. You can view the results of this check on the agent's local console.

To view the status of a system resource check

  1. Log in to your agent's local console:

  2. In the AWS Appliance Activation - Configuration main menu, enter 4 to view the results of a system resource check.

    The console displays an [OK], [WARNING], or [FAIL] message for each resource as described in the table following.

    Message Description
    [OK] The resource has passed the system resource check.
    [WARNING] The resource doesn't meet the recommended requirements, but your agent can continue to function. DataSync displays a message that describes the results of the resource check.
    [FAIL] The resource doesn't meet the minimum requirements. Your agent might not function properly. DataSync displays a message that describes the results of the resource check.

    The console also displays the number of errors and warnings next to the resource check menu option.

Configuring a Network Time Protocol (NTP) Server

You can view Network Time Protocol (NTP) server configurations and synchronize the VM time on your agent with your hypervisor host.

To manage system time

  1. Log in to your agent's local console.

  2. In the AWS Appliance Activation - Configuration main menu, enter 5 to manage your system's time.

  3. In the System Time Management menu, enter 1.

    To Do This
    View and synchronize your VM time with NTP server time.

    Enter 1.

    The current time of your agent is displayed. Your agent determines the time difference from your agent VM, and your NTP server time and prompts you to synchronize the agent time with NTP time.

    After your agent is deployed and running, in some scenarios the agent's time can drift. For example, suppose that there is a prolonged network outage and your hypervisor host and agent don't get time updates. In this case, the agent's time is different from the true time. When there is a time drift, a discrepancy occurs between the stated times when operations such as snapshots occur and the actual times that the operations occur.

    Edit your NTP server configuration

    Enter 2.

    You are prompted to provide a preferred and a secondary NTP server.

    View your NTP server configuration

    Enter 3.

    Your NTP server configuration is displayed.

Running AWS DataSync Commands on the Local Console

The VM local console in AWS DataSync helps provide a secure environment for configuring and diagnosing issues with your agent. Using the local console commands, you can perform maintenance tasks such as saving routing tables, connecting to AWS Support, and so on.

To run a configuration or diagnostic command

  1. Log in to your agent's local console.

  2. On the AWS Appliance Activation - Configuration main menu, enter 6 for Command Prompt.

  3. On the AWS Appliance Activation - Command Prompt console, enter h, and then press the Return key.

    The console displays the AVAILABLE COMMANDS menu with what the commands do, as shown in the following screenshot.

  4. At the command prompt, enter the command that you want to use and follow the instructions.

To learn about a command, enter the command name at the command prompt.

Enabling AWS Support to Help Troubleshoot Your Running On-Premises Agent

You can allow AWS Support to access your agent, and assist you with troubleshooting agent issues. By default, AWS Support access to your DataSync is disabled. You enable this access through the host's local console. To give AWS Support access to your DataSync, you first log in to the local console for the host then connect to the support server.

To enable AWS Support access to AWS DataSync

  1. Log in to your host's local console. Use the user name admin and the password password.

    The local console looks like the following.

  2. At the prompt, type 6 to open the help menu.

  3. Type h to open the AVAILABLE COMMANDS window.

  4. In the AVAILABLE COMMANDS window, type open-support-channel to connect to customer support. You must allow TCP port 22 to initiate a support channel to AWS. When you connect to customer support, DataSync assigns you a support number. Make a note of your support number.

    Note

    The channel number is not a Transmission Control Protocol/User Datagram Protocol (TCP/UDP) port number. Instead, it makes a Secure Shell (SSH) (TCP 22) connection to servers and provides the support channel for the connection.

  5. Once the support channel is established, provide your support service number to AWS Support so AWS Support can provide troubleshooting assistance.

  6. When the support session is completed, type q to end it.

  7. Type exit to log out of the DataSync local console.

  8. Follow the prompts to exit the local console.