Performing tasks on the Amazon EC2 local console (File Gateway) - AWS Storage Gateway

Amazon FSx File Gateway documentation has been moved to What is Amazon FSx File Gateway?

Volume Gateway documentation has been moved to What is Volume Gateway?

Tape Gateway documentation has been moved to What is Tape Gateway?

Performing tasks on the Amazon EC2 local console (File Gateway)

Some maintenance tasks require that you log in to the local console when running a gateway 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 your Amazon EC2 gateway 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 need the SSH key pair that you specified when you launched your instance. For information about Amazon EC2 key pairs, see Amazon EC2 key pairs in the Amazon EC2 User Guide.

To log in to the gateway local console

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

  2. After you log in, you see the AWS Appliance Activation - Configuration main menu, from which you can perform various tasks.

    To Learn About This Task See This Topic
    Configure an HTTP proxy for your gateway Routing your gateway deployed on EC2 through an HTTP proxy
    Configure network settings for your gateway Configuring your gateway network settings
    Test network connectivity Testing your gateway's network connectivity
    View a system resource check Viewing your gateway system resource status.
    Run Storage Gateway console commands Running Storage Gateway commands on the local console

To shut down the gateway, enter 0.

To exit the configuration session, enter X.

Routing your gateway deployed on EC2 through an HTTP proxy

Storage Gateway supports the configuration of a Socket Secure version 5 (SOCKS5) proxy between your gateway deployed on Amazon EC2 and AWS.

If your gateway must use a proxy server to communicate to the internet, then you need to configure the HTTP proxy settings for your gateway. You do this by specifying an IP address and port number for the host running your proxy. After you do so, Storage Gateway routes all AWS endpoint traffic through your proxy server. Communications between the gateway and endpoints is encrypted, even when using the HTTP proxy.

To route your gateway internet traffic through a local proxy server

  1. Log in to your gateway's local console. For instructions, see Logging in to your Amazon EC2 gateway local console.

  2. From the AWS Appliance Activation - Configuration main menu, enter the corresponding numeral to select Configure HTTP Proxy.

  3. From the AWS Appliance Activation HTTP Proxy Configuration menu, enter the corresponding numeral for the task you want to perform:

    • Configure HTTP proxy - You will need to supply a host name and port to complete configuration.

    • View current HTTP proxy configuration - If an HTTP proxy is not configured, the message HTTP Proxy not configured is displayed. If an HTTP proxy is configured, the host name and port of the proxy are displayed.

    • Remove an HTTP proxy configuration - The message HTTP Proxy Configuration Removed is displayed.

Testing your gateway's network connectivity

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

To test your gateway's connectivity

  1. Log in to your gateway's local console. For instructions, see Logging in to your Amazon EC2 gateway local console.

  2. From the AWS Appliance Activation - Configuration main menu, enter the corresponding numeral to select Test Network Connectivity.

    If your gateway has already been activated, the connectivity test begins immediately. For gateways that have not yet been activated, you must specify the endpoint type and AWS Region as described in the following steps.

  3. If your gateway is not yet activated, enter the corresponding numeral to select the endpoint type for your gateway.

  4. If you selected the public endpoint type, enter the corresponding numeral to select the AWS Region that you want to test. For supported AWS Regions and a list of AWS service endpoints you can use with Storage Gateway, see AWS Storage Gateway endpoints and quotas in the AWS General Reference.

As the test progresses, each endpoint displays either [PASSED] or [FAILED], indicating the status of the connection as follows:

Message Description
[PASSED] Storage Gateway has network connectivity.
[FAILED] Storage Gateway does not have network connectivity.

Viewing your gateway system resource status

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

To view the status of a system resource check

  1. Log in to your gateway's local console. For instructions, see Logging in to your Amazon EC2 gateway local console.

  2. From the AWS Appliance Activation - Configuration main menu, enter the corresponding numeral to select View System Resource Check.

    Each resource displays [OK], [WARNING], or [FAIL], indicating the status of the resource as follows:

    Message Description
    [OK] The resource has passed the system resource check.
    [WARNING] The resource doesn't meet the recommended requirements, but your gateway can continue to function. Storage Gateway displays a message that describes the results of the resource check.
    [FAIL] The resource doesn't meet the minimum requirements. Your gateway might not function properly. Storage Gateway 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.

Running Storage Gateway commands on the local console

The AWS Storage Gateway console helps provide a secure environment for configuring and diagnosing issues with your gateway. 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 gateway's local console. For instructions, see Logging in to your Amazon EC2 gateway local console.

  2. From the AWS Appliance Activation - Configuration main menu, enter the corresponding numeral to select Gateway Console.

  3. From the gateway console command prompt, enter h.

    The console displays the AVAILABLE COMMANDS menu, which lists the available commands:

    Command Function
    dig Collect output from dig for DNS troubleshooting.
    exit Return to Configuration menu.
    h Display available command list.
    ifconfig View or configure network interfaces.
    Note

    We recommend configuring network or IP settings using the Storage Gateway console or the dedicated local console menu option. For instructions, see Configuring your gateway network settings.

    ip Show / manipulate routing, devices, and tunnels.
    Note

    We recommend configuring network or IP settings using the Storage Gateway console or the dedicated local console menu option. For instructions, see Configuring your gateway network settings.

    iptables Administration tool for IPv4 packet filtering and NAT.
    ncport Test connectivity to a specific TCP port on a network.
    nping Collect output from nping for network troubleshooting.
    open-support-channel Connect to AWS Support.
    save-iptables Persist IP tables.
    save-routing-table Save newly added routing table entry.
    tcptraceroute Collect traceroute output on TCP traffic to a destination.
  4. From the gateway console command prompt, enter the corresponding command for the function you want to use, and follow the instructions.

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

Configuring your gateway network settings

You can view and configure your Domain Name Server (DNS) settings through the local console.

To configure your gateway to use static IP addresses

  1. Log in to your gateway's local console. For instructions, see Logging in to your Amazon EC2 gateway local console.

  2. From the AWS Appliance Activation - Configuration main menu, enter the corresponding numeral to select Network Configuration.

  3. From the AWS Appliance Activation - Network Configuration menu, enter the corresponding numeral for the task you want to perform:

    • Edit DNS Configuration - The available adapters of the primary and secondary DNS servers are displayed. You are prompted to provide the new IP address.

    • View DNS Configuration - The available adapters of the primary and secondary DNS servers are displayed.