Getting an activation key for your gateway
To receive an activation key for your gateway, make a web request to the gateway virtual
machine (VM). The VM returns a redirect that contains the activation key, which is passed as one
of the parameters for the ActivateGateway
API action to specify the configuration
of your gateway. For more information, see ActivateGateway in
the Storage Gateway API Reference.
Note
Gateway activation keys expire in 30 minutes if unused.
The request that you make to the gateway VM includes the Amazon Region where the activation
occurs. The URL that's returned by the redirect in the response contains a query string
parameter called activationkey
. This query string parameter is your activation key.
The format of the query string looks like the following:
http://
.
The output of this query returns both activation region and key.gateway_ip_address
/?activationRegion=activation_region
The URL also includes vpcEndpoint
, the VPC Endpoint ID for gateways that
connect using the VPC endpoint type.
Note
The Amazon Storage Gateway Hardware Appliance, VM image templates, and Amazon EC2 Amazon Machine Images (AMI) come preconfigured with the HTTP services necessary to receive and respond to the web requests described on this page. It's not required or recommended to install any additional services on your gateway.
Linux (curl)
The following examples show you how to get an activation key using Linux (curl).
Note
Replace the highlighted variables with actual values for your gateway. Acceptable values are as follows:
-
gateway_ip_address
- The IPv4 address of your gateway, for example172.31.29.201
-
gateway_type
- The type of gateway you want to activate, such asSTORED
,CACHED
,VTL
,FILE_S3
, orFILE_FSX_SMB
. -
region_code
- The Region where you want to activate your gateway. See Regional endpoints in the Amazon General Reference Guide. If this parameter is not specified, or if the value provided is misspelled or doesn't match a valid region, the command will default to theus-east-1
region. -
vpc_endpoint
- The VPC endpoint name for your gateway, for examplevpce-050f90485f28f2fd0-iep0e8vq.storagegateway.us-west-2.vpce.amazonaws.com
.
To get the activation key for a public endpoint:
curl "http://
gateway_ip_address
/?activationRegion=region_code
&no_redirect"
To get the activation key for a VPC endpoint:
curl "http://
gateway_ip_address
/?activationRegion=region_code
&vpcEndpoint=vpc_endpoint
&no_redirect"
Linux (bash/zsh)
The following example shows you how to use Linux (bash/zsh) to fetch the HTTP response, parse HTTP headers, and get the activation key.
function get-activation-key() { local ip_address=$1 local activation_region=$2 if [[ -z "$ip_address" || -z "$activation_region" || -z "$gateway_type" ]]; then echo "Usage: get-activation-key ip_address activation_region gateway_type" return 1 fi if redirect_url=$(curl -f -s -S -w '%{redirect_url}' "http://$ip_address/?activationRegion=$activation_region&gatewayType=$gateway_type"); then activation_key_param=$(echo "$redirect_url" | grep -oE 'activationKey=[A-Z0-9-]+') echo "$activation_key_param" | cut -f2 -d= else return 1 fi }
Microsoft Windows PowerShell
The following example shows you how to use Microsoft Windows PowerShell to fetch the HTTP response, parse HTTP headers, and get the activation key.
function Get-ActivationKey { [CmdletBinding()] Param( [parameter(Mandatory=$true)][string]$IpAddress, [parameter(Mandatory=$true)][string]$ActivationRegion, [parameter(Mandatory=$true)][string]$GatewayType ) PROCESS { $request = Invoke-WebRequest -UseBasicParsing -Uri "http://$IpAddress/?activationRegion=$ActivationRegion&gatewayType=$GatewayType" -MaximumRedirection 0 -ErrorAction SilentlyContinue if ($request) { $activationKeyParam = $request.Headers.Location | Select-String -Pattern "activationKey=([A-Z0-9-]+)" $activationKeyParam.Matches.Value.Split("=")[1] } } }
Using your local console
The following example shows you how to use your local console to generate and display an activation key.
To get an activation key for your gateway from your local console
-
Log in to your local console. If you are connecting to your Amazon EC2 instance from a Windows computer, log in as admin.
-
After you log in and see the Amazon Appliance Activation - Configuration main menu, select
0
to choose Get activation key. -
Select Storage Gateway for gateway family option.
-
When prompted, enter the Amazon Region where you want to activate your gateway.
-
Enter
1
for Public or2
for VPC endpoint as the network type. -
Enter
1
for Standard or2
for Federal Information Processing Standard (FIPS) as the endpoint Type.