Menu
Amazon Elastic File System
User Guide

Managing Amazon EFS File Sync

In this section, you can find information about how to manage your Amazon EFS File Sync.

Deleting a Sync Agent

If you no longer need a sync agent, you can delete it from the Amazon EFS Management Console.

To delete a sync agent

  1. Choose File syncs, choose Agents, and then choose the sync agent that you want to delete.

  2. For Actions, choose Delete.

  3. In the Confirm deletion of sync agent dialog box, choose Check box confirm deletion, and then choose OK.

Deleting a Sync Task

If you no longer need a sync task, you can delete it from the Amazon EFS Management Console.

To delete a sync task

  1. Choose File syncs, choose Tasks, and then choose the sync task that you want to delete.

  2. For Actions, choose Delete.

  3. In the Confirm deletion of sync task dialog box, choose Check box confirm deletion, and then choose OK.

Understanding Sync Agent Status

The following table describes each sync agent status, and if and when you should take action based on the status. When a sync agent is in use, it has Running status all or most of the time.

Sync Agent Status Meaning
Running The sync agent is configured properly and is available to use. The Running status is the normal running status for a sync agent.
Offline The sync agent's VM or EC instance is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to Running status.

Understanding Sync Task Status

The following table described each sync task status, and if and when you should take action based on the status.

Sync Task Status Meaning
Available The sync task is configured properly and is available to be started.
Completed The task creating process has completed.
Creating EFS File Sync is creating the sync task.
Error
Starting The task creating process has started.
Preparing The sync task is examining the source and destination file systems to determine which files to sync.
Syncing EFS File Sync is syncing file from the source file system to the destination Amazon EFS file system.
Verifying EFS File Sync is verifying consistency between the source and destination file systems.

Performing Tasks on the EFS File Sync VM Local Console

For a EFS File Sync deployed on-premises, you can perform the following maintenance tasks using the VM host's local console.

Logging in to the Local Console Using Default Credentials

When the VM is ready for you to log in, the login screen is displayed.

To log in to the EFS File Sync's local console

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

After you log in, you see the Amazon EFS File Sync Configuration main menu, as shown in the following screenshot.

Note

We recommend changing the default password. You do this by running the passwd command from the EFS File Sync Command Prompt (item 5 on the main menu). For information about how to run the command, see Running EFS File Sync Commands on the Local Console.

To shut down EFS File Sync, type 0.

To exit the configuration session, type x to exit the menu.

Configuring Your EFS File Sync Network

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

To configure your EFS File Sync to use static IP addresses

  1. Log in to your EFS File Sync's local console.

  2. On the Amazon EFS File Sync Configuration main menu, type option 1 to begin configuring a static IP address.

  3. Choose one of the following options on the Amazon EFS File Sync Configuration menu:

    To Do This
    Describe network adapter

    Type option 1.

    A list of adapter names appears, and you are prompted to type 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

    • EFS File Sync 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 EFS File Sync's default route adapter (option 5).

    Configure DHCP

    Type option 2.

    You are prompted to configure network interface to use DHCP.

    Configure a static IP address for your EFS File Sync

    Type option 3.

    You are prompted to type the following information to configure a static IP:

    • Network adapter name

    • IP address

    • Netmask

    • Default EFS File Sync address

    • Primary Domain Name Service (DNS) address

    • Secondary DNS address

    Important

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

    If your EFS File Sync uses more than one network interface, you must set all enabled interfaces to use DHCP or static IP addresses.

    For example, suppose your EFS File Sync VM uses two interfaces configured as DHCP. If you later set one interface to a static IP, the other interface is disabled. To enable the interface in this case, you must set it to a static IP.

    If both interfaces are initially set to use static IP addresses and you then set the EFS File Sync to use DHCP, both interfaces will use DHCP.

    Reset all your EFS File Sync's network configuration to DHCP

    Type option 4.

    All network interfaces are set to use DHCP.

    Important

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

    Set your EFS File Sync's default route adapter

    Type option 5.

    The available adapters for your EFS File Sync are shown, and you are prompted to select one of the adapters—for example, eth0.

    View your EFS File Sync's DNS configuration

    Type option 6.

    The IP addresses of the primary and secondary DNS name servers are displayed.

    View routing tables

    Type option 7.

    The default route of your EFS File Sync is displayed.

Testing Your EFS File Sync Connection to the Internet

You can use your EFS File Sync's local console to test your Internet connection. This test can be useful when you are troubleshooting network issues with your EFS File Sync.

To test your EFS File Sync's connection to the Internet

  1. Log in to your EFS File Sync's local console.

  2. On the EFS File Sync Configuration main menu, type option 2 to begin testing network connectivity.

  3. The endpoint in the selected region displays either a PASSED or FAILED message, as shown following.

    Message Description
    [ PASSED ] EFS File Sync has Internet connectivity.
    [ FAILED ] EFS File Sync does not have Internet connectivity.

Viewing Your EFS File Sync System Resource Status

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

To view the status of a system resource check

  1. Log in to your EFS File Sync's local console.

  2. In the EFS File Sync Configuration main menu, type 3 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 does not meet the recommended requirements, but your EFS File Sync will continue to function. EFS File Sync displays a message that describes the results of the resource check.
    [FAIL] The resource does not meet the minimum requirements. Your EFS File Sync might not function properly. EFS File Sync 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.

    The following screenshot shows a [FAIL] message and the accompanying error message.

Synchronizing Your EFS File Sync VM Time

After your EFS File Sync is deployed and running, in some scenarios the EFS File Sync VM's time can drift. For example, if there is a prolonged network outage and your hypervisor host and EFS File Sync do not get time updates, then the EFS File Sync VM's time will be 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.

For a EFS File Sync deployed on VMware ESXi, setting the hypervisor host time and synchronizing the VM time to the host is sufficient to avoid time drift.

Running EFS File Sync Commands on the Local Console

The EFS File Sync console helps provide a secure environment for configuring and diagnosing issues with your EFS File Sync. Using the console commands, you can perform maintenance tasks such as saving routing tables or connecting to AWS Support.

To run a configuration or diagnostic command

  1. Log in to your EFS File Sync's local console.

  2. On the EFS File Sync Configuration main menu, type option 5 for Command Prompt.

  3. On the EFS File Sync console, type h, and then press the Return key.

    The console displays the Available Commands menu with the available commands and after the menu a Command Prompt, as shown in the following screenshot.

  4. To learn about a command, type man + command name at the EFS File Sync Console prompt.

Performing Tasks on Amazon EC2 EFS File Sync Local Console

Some maintenance tasks require that you log in to the local console when running a EFS File Sync deployed on an Amazon EC2 instance. In this section, you can find information about how to log in to the local console and perform maintenance tasks.

Logging In to Amazon EC2 EFS File Sync Local Console

You can connect to your Amazon EC2 instance by using a Secure Shell (SSH) client. For detailed information, see Connect to Your Instance in the Amazon EC2 User Guide. To connect this way, you will need the SSH key pair you specified when you launched the instance. For information about Amazon EC2 key pairs, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide.

To log in to the EFS File Sync local console

  1. Log in to your local console. If you are connecting to your EC2 instance from a Windows computer, log in as sguser.

  2. After you log in, you see the Amazon EFS File Sync Configuration main menu, as shown in the following screenshot.

    To See
    Test network connectivity Testing EFS File Sync Connectivity to the Internet
    View a system resource check Viewing EFS File Sync System Resource Status.
    Run EFS File Sync console commands Running EFS File Sync Commands on the Local Console

To shut down the EFS File Sync, type 0.

To exit the configuration session, type x to exit the menu.

Testing EFS File Sync Connectivity to the Internet

You can use your EFS File Sync's local console to test your Internet connection. This test can be useful when you are troubleshooting network issues.

To test EFS File Sync's connection to the Internet

  1. Log in to your EFS File Sync's local console. For instructions, see Logging In to Amazon EC2 EFS File Sync Local Console.

  2. In the Amazon EFS File Sync Configuration main menu, type 1 to begin testing network connectivity.

  3. The endpoint in the region you select displays either a [PASSED] or [FAILED] message, as shown following.

    Message Description
    [PASSED] EFS File Sync has Internet connectivity.
    [FAILED] EFS File Sync does not have Internet connectivity.

Viewing EFS File Sync System Resource Status

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

To view the status of a system resource check

  1. Log in to your EFS File Sync's local console. For instructions, see Logging In to Amazon EC2 EFS File Sync Local Console.

  2. In the Amazon EFS File Sync Configuration main menu, type 2 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 does not meet the recommended requirements, but your EFS File Sync will continue to function. EFS File Sync displays a message that describes the results of the resource check.
    [FAIL] The resource does not meet the minimum requirements. Your EFS File Sync might not function properly. EFS File Sync 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.

    The following screenshot shows a [FAIL] message and the accompanying error message.

Running EFS File Sync Commands on the Local Console

The EFS File Sync local console helps provide a secure environment for configuring and diagnosing issues with your EFS File Sync. Using the local console commands, you can perform maintenance tasks such as saving routing tables or connecting to AWS Support.

To run a configuration or diagnostic command

  1. Log in to your EFS File Sync's local console. For instructions, see Logging In to Amazon EC2 EFS File Sync Local Console.

  2. In the Amazon EFS File Sync Configuration main menu, type 3 for EFS File Sync Console.

  3. In the EFS File Sync console, type h, and then press the Return key.

    The console displays the Available Commands menu with the available commands. After the menu, a EFS File Sync Console prompt appears, as shown in the following screenshot.

  4. To learn about a command, type man + command name at the EFS File Sync Console prompt.