Menu
AWS Storage Gateway
User Guide (API Version 2013-06-30)

Performing Maintenance Tasks on the Amazon EC2 Gateway Local Console

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 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 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 sguser.

  2. After you log in, you see the AWS Storage Gateway Configuration main menu, as shown in the following screenshot.

    To See
    Configure a SOCKS proxy for your gateway Routing Your Gateway Deployed on Amazon EC2 Through a Proxy
    Test network connectivity Testing Your Gateway Connectivity to the Internet
    Run Storage Gateway console commands Running Storage Gateway Commands on the Local Console
    View a system resource check Logging In to Your Amazon EC2 Gateway Local Console.

To shut down the gateway, type 0.

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

Routing Your Gateway Deployed on Amazon EC2 Through a Proxy

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

Note

The only proxy configuration AWS Storage Gateway supports is SOCKS5.

If your gateway must use a proxy server to communicate to the Internet, then you need to configure the SOCKS 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, AWS Storage Gateway will route all HyperText Transfer Protocol Secure (HTTPS) traffic through your proxy server.

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. On the AWS Storage Gateway Configuration main menu, type 1 to begin configuring the SOCKS proxy.

  3. Choose one of the following options in the AWS Storage Gateway SOCKS Proxy Configuration menu:

    To Do This
    Configure a SOCKS proxy

    Type 1.

    You need to supply a host name and port to complete configuration.

    View the current SOCKS proxy configuration

    Type 2.

    If a SOCKS proxy is not configured, the message SOCKS Proxy not configured is displayed. If a SOCKS proxy is configured, the host name and port of the proxy are displayed.

    Remove a SOCKS proxy configuration

    Type 3.

    The message SOCKS Proxy Configuration Removed is displayed.

    Exit this menu and return to the previous menu

    Type x.

Testing Your Gateway Connectivity to the Internet

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

To test your gateway's connection to the Internet

  1. Log in to your gateway's local console. For instructions, see Logging In to Your Amazon EC2 Gateway Local Console.

  2. In the AWS Storage Gateway Configuration main menu, type 2 to begin testing network connectivity.

    The console displays the available regions.

  3. Select the region you want to test. Following are the available regions for gateways deployed an EC2 instance.

    Region Name Region String File Gateway Volume Gateway Tape Gateway
    US East (Ohio) us-east-2

    yes

    yes

    yes

    US East (N. Virginia) us-east-1

    yes

    yes

    yes

    US West (N. California) us-west-1

    yes

    yes

    yes

    US West (Oregon) us-west-2

    yes

    yes

    yes

    Canada (Central) ca-central-1

    yes

    yes

    yes

    EU (Ireland) eu-west-1

    yes

    yes

    yes

    EU (Frankfurt) eu-central-1

    yes

    yes

    yes

    EU (London) eu-west-2

    yes

    yes

    yes

    Asia Pacific (Tokyo) ap-northeast-1

    yes

    yes

    yes

    Asia Pacific (Seoul) ap-northeast-2

    yes

    yes

    yes

    Asia Pacific (Singapore) ap-southeast-1

    yes

    yes

    no

    Asia Pacific (Sydney) ap-southeast-2

    yes

    yes

    yes

    Asia Pacific (Mumbai) ap-south-1

    yes

    yes

    yes

    South America (São Paulo) sa-east-1

    yes

    yes

    no

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

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

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. In the AWS Storage Gateway Configuration main menu, type 3 for Gateway Console.

  3. In the Storage Gateway console, type h, and then press the Return key.

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

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

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

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