id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
storagegateway-s3file-ug-140
|
storagegateway-s3file-ug.pdf
| 140 |
local console 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: Linux (curl) API Version 2013-06-30 349 AWS Storage Gateway Amazon S3 File Gateway User Guide • gateway_ip_address - The IPv4 address of your gateway, for example 172.31.29.201 • gateway_type - The type of gateway you want to activate, such as STORED, CACHED, VTL, FILE_S3, or FILE_FSX_SMB. • region_code - The Region where you want to activate your gateway. See Regional endpoints in the AWS 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 the us-east-1 region. • vpc_endpoint - The VPC endpoint name for your gateway, for example vpce-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 Linux (bash/zsh) API Version 2013-06-30 350 AWS Storage Gateway Amazon S3 File Gateway User Guide 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 1. Log in to your local console. If you are connecting to your Amazon EC2 instance from a Windows computer, log in as admin. Microsoft Windows PowerShell API Version 2013-06-30 351 AWS Storage Gateway Amazon S3 File Gateway User Guide 2. After you log in and see the AWS Appliance Activation - Configuration main menu, select 0 to choose Get activation key. 3. Select Storage Gateway for gateway family option. 4. When prompted, enter the AWS Region where you want to activate your gateway. 5. 6. Enter 1 for Public or 2 for VPC endpoint as the network type. Enter 1 for Standard or 2 for Federal Information Processing Standard (FIPS) as the endpoint Type. Support for file attributes in Amazon S3 File Gateway Amazon S3 File Gateway supports DOS or Windows file attributes by default. Using S3 File Gateway, you can preserve file data and metadata and update settings — such as marking items as archived when they are placed in Amazon S3. For more information about DOS and Windows file attributes, see the File Attribute Constants article on the Windows app development documentation website. S3 File Gateway supports the following attributes: • ReadOnly – The S3 File Gateway prevents changes to files that have the ReadOnly attribute set. • Archive – The S3 File Gateway sets this attribute when files are first added to the gateway. Note Backup applications commonly backup files that have the Archive bit set and then clear the bit after successful backup. • Hidden – Server Message Block (SMB) clients hide files that use this bit set. • System – This attribute persists once you have set it. When you copy a file to the S3 File Gateway with the attributes set, the file's DOS or Windows attributes are preserved on the S3 File Gateway and in Amazon S3. You can update these attributes for files on the gateway, and those updates also apply to the object in Amazon S3. If a file is evicted from the gateway the gateway pull the file, its metadata, and its persistent attributes from Amazon S3 when you request. File attribute support API Version 2013-06-30 352 AWS Storage Gateway Amazon S3 File Gateway User Guide Note DOS attributes are only supported on SMB shares and if access is controlled by Windows Access Control Lists. Using AWS Direct Connect with Storage Gateway AWS Direct Connect links your internal network to the Amazon Web Services Cloud. By using AWS Direct Connect with Storage Gateway, you can create a connection for high-throughput workload needs, providing a dedicated network connection between your on-premises gateway and AWS. Storage Gateway uses public endpoints. With an AWS
|
storagegateway-s3file-ug-141
|
storagegateway-s3file-ug.pdf
| 141 |
its persistent attributes from Amazon S3 when you request. File attribute support API Version 2013-06-30 352 AWS Storage Gateway Amazon S3 File Gateway User Guide Note DOS attributes are only supported on SMB shares and if access is controlled by Windows Access Control Lists. Using AWS Direct Connect with Storage Gateway AWS Direct Connect links your internal network to the Amazon Web Services Cloud. By using AWS Direct Connect with Storage Gateway, you can create a connection for high-throughput workload needs, providing a dedicated network connection between your on-premises gateway and AWS. Storage Gateway uses public endpoints. With an AWS Direct Connect connection in place, you can create a public virtual interface to allow traffic to be routed to the Storage Gateway endpoints. The public virtual interface bypasses internet service providers in your network path. The Storage Gateway service public endpoint can be in the same AWS Region as the AWS Direct Connect location, or it can be in a different AWS Region. The following illustration shows an example of how AWS Direct Connect works with Storage Gateway. network architecture showing Storage Gateway connected to the cloud using AWS direct connect. The following procedure assumes that you have created a functioning gateway. To use AWS Direct Connect with Storage Gateway 1. Create and establish an AWS Direct Connect connection between your on-premises data center and your Storage Gateway endpoint. For more information about how to create a connection, see Getting Started with AWS Direct Connect in the AWS Direct Connect User Guide. 2. Connect your on-premises Storage Gateway appliance to the AWS Direct Connect router. 3. Create a public virtual interface, and configure your on-premises router accordingly. For more information, see Creating a Virtual Interface in the AWS Direct Connect User Guide. For details about AWS Direct Connect, see What is AWS Direct Connect? in the AWS Direct Connect User Guide. Using AWS Direct Connect API Version 2013-06-30 353 AWS Storage Gateway Amazon S3 File Gateway User Guide Active Directory service account permission requirements If you plan to use Microsoft Active directory to provide user authenticated access to the file shares on your AWS Storage Gateway, you need to make sure that you have an Active Directory service account, and that the service account has delegated permissions to join computers to your domain. A service account is an Active Directory user account that has been delegated permission to perform certain tasks. You provide the username and password credentials for this account when you join a Storage Gateway to your Active Directory domain. The Active Directory service account must be delegated the following permissions in the OU to which you are joining your gateway: • Ability to create and delete computer objects • Ability to reset passwords • Ability to modify permissions • Ability to restrict accounts from reading and writing data • Validated ability to read and write Account Restrictions • Validated ability to write to the service principal name • Validated ability to write to the DNS host name These represent the minimum set of permissions that are required to join computer objects to your Active Directory. For more information, see the Microsoft Windows Server documentation topic Error: Access is denied when non-administrator users who have been delegated control try to join computers to a domain controller. Getting the IP address for your gateway appliance After you choose a host and deploy your gateway VM, you connect and activate your gateway. To do this, you need the IP address of your gateway VM. You get the IP address from your gateway's local console. You log in to the local console and get the IP address from the top of the console page. For gateways deployed on-premises, you can also get the IP address from your hypervisor. For Amazon EC2 gateways, you can also get the IP address of your Amazon EC2 instance from the Amazon EC2 Management Console. To find how to get your gateway's IP address, see one of the following: Active Directory permissions API Version 2013-06-30 354 AWS Storage Gateway Amazon S3 File Gateway User Guide • VMware host: Accessing the Gateway Local Console with VMware ESXi • HyperV host: Access the Gateway Local Console with Microsoft Hyper-V • Linux Kernel-based Virtual Machine (KVM) host: Accessing the Gateway Local Console with Linux KVM • EC2 host: Getting an IP Address from an Amazon EC2 Host When you locate the IP address, take note of it. Then return to the Storage Gateway console and type the IP address into the console. Getting an IP Address from an Amazon EC2 Host To get the IP address of the Amazon EC2 instance your gateway is deployed on, log in to the EC2 instance's local console. Then get the IP address from the top of the console page. For instructions, see
|
storagegateway-s3file-ug-142
|
storagegateway-s3file-ug.pdf
| 142 |
Hyper-V • Linux Kernel-based Virtual Machine (KVM) host: Accessing the Gateway Local Console with Linux KVM • EC2 host: Getting an IP Address from an Amazon EC2 Host When you locate the IP address, take note of it. Then return to the Storage Gateway console and type the IP address into the console. Getting an IP Address from an Amazon EC2 Host To get the IP address of the Amazon EC2 instance your gateway is deployed on, log in to the EC2 instance's local console. Then get the IP address from the top of the console page. For instructions, see . You can also get the IP address from the Amazon EC2 Management Console. We recommend using the public IP address for activation. To get the public IP address, use procedure 1. If you choose to use the elastic IP address instead, see procedure 2. Procedure 1: To connect to your gateway using the public IP address 1. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. 2. In the navigation pane, choose Instances, and then select the EC2 instance that your gateway is deployed on. 3. Choose the Description tab at the bottom, and then note the public IP. You use this IP address to connect to the gateway. Return to the Storage Gateway console and type in the IP address. If you want to use the elastic IP address for activation, use the procedure following. Procedure 2: To connect to your gateway using the elastic IP address 1. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. 2. In the navigation pane, choose Instances, and then select the EC2 instance that your gateway is deployed on. 3. Choose the Description tab at the bottom, and then note the Elastic IP value. You use this elastic IP address to connect to the gateway. Return to the Storage Gateway console and type in the elastic IP address. Getting an IP Address from an Amazon EC2 Host API Version 2013-06-30 355 AWS Storage Gateway Amazon S3 File Gateway User Guide 4. After your gateway is activated, choose the gateway that you just activated, and then choose the VTL devices tab in the bottom panel. 5. Get the names of all your VTL devices. 6. For each target, run the following command to configure the target. iscsiadm -m node -o new -T [$TARGET_NAME] -p [$Elastic_IP]:3260 7. For each target, run the following command to log in. iscsiadm -m node -p [$ELASTIC_IP]:3260 --login Your gateway is now connected using the elastic IP address of the EC2 instance. Understanding Storage Gateway resources and resource IDs In Storage Gateway, the primary resource is a gateway but other resource types is file share. File shares are referred to as subresources and they don't exist unless they are associated with a gateway. These resources and subresources have unique Amazon Resource Names (ARNs) associated with them as shown in this table. Resource Type Gateway ARN File Share ARN ARN Format arn:aws:storagegateway: region:account-id :gateway/ gateway- id arn:aws:storagegateway: region:account-id :share/share-id Working with Resource IDs When you create a resource, Storage Gateway assigns the resource a unique resource ID. This resource ID is part of the resource ARN. A resource ID takes the form of a resource identifier, followed by a hyphen, and a unique combination of eight letters and numbers. For example, a gateway ID is of the form sgw-12A3456B where sgw is the resource identifier for gateways. Understanding resources and resource IDs API Version 2013-06-30 356 AWS Storage Gateway Amazon S3 File Gateway User Guide Storage Gateway resource IDs are in uppercase. However, when you use these resource IDs with the Amazon EC2 API, Amazon EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-1122AABB. When you use this ID with the EC2 API, you must change it to vol-1122aabb. Otherwise, the EC2 API might not behave as expected. Important IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS Resource IDs. For example, a volume ARN with the longer volume ID format will look like this: arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABBCCDDEEFFG. A snapshot ID with the longer ID format will look like this: snap-78e226633445566ee. For more information, see Announcement: Heads-up – Longer Storage Gateway volume and snapshot IDs coming in 2016. Tagging Storage Gateway resources In Storage Gateway, you can use tags to manage your resources. Tags let you add metadata to your resources and
|
storagegateway-s3file-ug-143
|
storagegateway-s3file-ug.pdf
| 143 |
you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS Resource IDs. For example, a volume ARN with the longer volume ID format will look like this: arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/ volume/vol-1122AABBCCDDEEFFG. A snapshot ID with the longer ID format will look like this: snap-78e226633445566ee. For more information, see Announcement: Heads-up – Longer Storage Gateway volume and snapshot IDs coming in 2016. Tagging Storage Gateway resources In Storage Gateway, you can use tags to manage your resources. Tags let you add metadata to your resources and categorize your resources to make them easier to manage. Each tag consists of a key- value pair, which you define. You can add tags to gateways, volumes, and virtual tapes. You can search and filter these resources based on the tags you add. As an example, you can use tags to identify Storage Gateway resources used by each department in your organization. You might tag gateways and volumes used by your accounting department like this: (key=department and value=accounting). You can then filter with this tag to identify all gateways and volumes used by your accounting department and use the information to determine cost. For more information, see Using Cost Allocation Tags and Working with Tag Editor. If you archive a virtual tape that is tagged, the tape maintains its tags in the archive. Similarly, if you retrieve a tape from the archive to another gateway, the tags are maintained in the new gateway. Tagging your resources API Version 2013-06-30 357 AWS Storage Gateway Amazon S3 File Gateway User Guide For File Gateway, you can use tags to control access to resources. For information about how to do this, see Using tags to control access to your gateway and resources. Tags don’t have any semantic meaning but rather are interpreted as strings of characters. The following restrictions apply to tags: • Tag keys and values are case-sensitive. • The maximum number of tags for each resource is 50. • Tag keys cannot begin with aws:. This prefix is reserved for AWS use. • Valid characters for the key property are UTF-8 letters and numbers, space, and special characters + - = . _ : / and @. Working with tags You can work with tags by using the Storage Gateway console, the Storage Gateway API, or the Storage Gateway Command Line Interface (CLI). The following procedures show you how to add, edit, and delete a tag on the console. To add a tag 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. In the navigation pane, choose the resource you want to tag. For example, to tag a gateway, choose Gateways, and then choose the gateway you want to tag from the list of gateways. 3. Choose Tags, and then choose Add/edit tags. 4. 5. In the Add/edit tags dialog box, choose Create tag. Type a key for Key and a value for Value. For example, you can type Department for the key and Accounting for the value. Note You can leave the Value box blank. 6. Choose Create Tag to add more tags. You can add multiple tags to a resource. Working with tags API Version 2013-06-30 358 AWS Storage Gateway Amazon S3 File Gateway User Guide 7. When you’re done adding tags, choose Save. To edit a tag 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. Choose the resource whose tag you want to edit. 3. Choose Tags to open the Add/edit tags dialog box. 4. Choose the pencil icon next to the tag you want to edit, and then edit the tag. 5. When you’re done editing the tag, choose Save. To delete a tag 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. Choose the resource whose tag you want to delete. 3. Choose Tags, and then choose Add/edit tags to open the Add/edit tags dialog box. 4. Choose the X icon next to the tag you want to delete, and then choose Save. Working with open-source components for AWS Storage Gateway This section describes the third-party tools and licenses that we depend on to deliver AWS Storage Gateway functionality. Topics • Open-source components for Storage Gateway • Open-source components for Amazon S3 File Gateway Open-source components for Storage Gateway Several third-party tools and licenses are used to deliver functionality for Volume Gateway, Tape Gateway, and Amazon S3 File Gateway. Open-source components API Version 2013-06-30 359 AWS Storage Gateway Amazon S3 File Gateway User Guide Use the following links to download source code for certain open-source software components that are included with AWS Storage Gateway software: • For Storage Gateway appliances deployed on VMware ESXi: sources.tar • For Storage Gateway appliances deployed on Microsoft Hyper-V: sources_hyperv.tar • For Storage Gateway appliances deployed on
|
storagegateway-s3file-ug-144
|
storagegateway-s3file-ug.pdf
| 144 |
components for Storage Gateway • Open-source components for Amazon S3 File Gateway Open-source components for Storage Gateway Several third-party tools and licenses are used to deliver functionality for Volume Gateway, Tape Gateway, and Amazon S3 File Gateway. Open-source components API Version 2013-06-30 359 AWS Storage Gateway Amazon S3 File Gateway User Guide Use the following links to download source code for certain open-source software components that are included with AWS Storage Gateway software: • For Storage Gateway appliances deployed on VMware ESXi: sources.tar • For Storage Gateway appliances deployed on Microsoft Hyper-V: sources_hyperv.tar • For Storage Gateway appliances deployed on Linux Kernel-based Virtual Machine (KVM): sources_KVM.tar This product includes software developed by the OpenSSL project for use in the OpenSSL Toolkit (http://www.openssl.org/). For the relevant licenses for all dependent third-party tools, see Third- Party Licenses. Open-source components for Amazon S3 File Gateway Several third-party tools and licenses are used to deliver Amazon S3 File Gateway (S3 File Gateway) functionality. Use the following links to download the source code for certain open-source software components that are included with S3 File Gateway software: • For Amazon S3 File Gateway: sgw-file-s3-open-source.tgz This product includes software developed by the OpenSSL project for use in the OpenSSL Toolkit (http://www.openssl.org/). For the relevant licenses for all dependent third-party tools, see Third- Party Licenses. Limits and quotas for Amazon S3 File Gateway Quotas for file shares The following table lists quotas for file shares. Description Limit Maximum number of file shares per gateway 50 Open-source components for Amazon S3 File Gateway API Version 2013-06-30 360 Amazon S3 File Gateway User Guide Limit AWS Storage Gateway Description Note Each file share can only connect to one S3 bucket, but multiple file shares can connect to the same bucket. If you connect more than one file share to the same bucket, you must configure each file share to use a unique, non- overlapping prefix name to prevent read/write conflicts. The number of file shares managed by a gateway can impact the gateway's performance. For more informati on, see Performance guidance for gateways with multiple file shares. Quotas for file shares API Version 2013-06-30 361 Amazon S3 File Gateway User Guide Limit Gateway Capacity: Small — 5M files Medium — 10M files Large — 20M files AWS Storage Gateway Description The maximum number of files for which a gateway can simultaneously cache metadata Note Because S3 File Gateway is backed by Amazon S3, there is no maximum folder size or limit to the number of files that you can store or access using a gateway. Each gateway has a configurable limit that determines the number of files for which it can simultane ously cache metadata. You can use the UpdateGatewayInformation API action to set GatewayCapacity to Small, Medium, or Large. This setting impacts gateway performance and hardware recommendations. For more information, see Performance guidance for gateways with multiple file shares. The maximum size of an individual file, which is the maximum size of an individual object in Amazon S3 5 TB Note If you write a file larger than 5 TB, you get a "file too large" error message and only the first 5 TB of the file is uploaded. Quotas for file shares API Version 2013-06-30 362 AWS Storage Gateway Description Maximum path length Limit 1024 bytes Amazon S3 File Gateway User Guide Note Clients are not allowed to create a path exceeding this length, and doing so results in an error. This limit applies to both protocols supported by File Gateways, NFS and SMB. Path length in bytes is calculated from character bit values in UTF-8 encoding. Maximum file name length 255 bytes Note File Gateway does not support file names that exceed this length. File name length in bytes is calculate d from character bit values in UTF-8 encoding. Recommended local disk sizes for your gateway The following table recommends sizes for local disk storage for your deployed gateway. Gateway Type Cache (Minimum) Cache (Maximum) Other Required Local Disks S3 File Gateway 150 GiB 64 TiB — Recommended local disk sizes for your gateway API Version 2013-06-30 363 AWS Storage Gateway Amazon S3 File Gateway User Guide Note You can configure one or more local drives for your cache up to the maximum capacity. When adding cache to an existing gateway, it's important to create new disks in your host (hypervisor or Amazon EC2 instance). Don't change the size of existing disks if the disks have been previously allocated as a cache. Using storage classes Amazon S3 File Gateway supports the Amazon S3 Standard, Amazon S3 Standard-Infrequent Access, Amazon S3 One Zone-Infrequent Access, Amazon S3 Intelligent-Tiering, and S3 Glacier storage classes. For more information about storage classes, see Amazon S3 storage classes in the Amazon Simple Storage Service User Guide. Note S3 File Gateway does not currently
|
storagegateway-s3file-ug-145
|
storagegateway-s3file-ug.pdf
| 145 |
your cache up to the maximum capacity. When adding cache to an existing gateway, it's important to create new disks in your host (hypervisor or Amazon EC2 instance). Don't change the size of existing disks if the disks have been previously allocated as a cache. Using storage classes Amazon S3 File Gateway supports the Amazon S3 Standard, Amazon S3 Standard-Infrequent Access, Amazon S3 One Zone-Infrequent Access, Amazon S3 Intelligent-Tiering, and S3 Glacier storage classes. For more information about storage classes, see Amazon S3 storage classes in the Amazon Simple Storage Service User Guide. Note S3 File Gateway does not currently support the Amazon S3 Glacier Instant Retrieval storage class. Topics • Using storage classes with a File Gateway • Using the GLACIER storage class with File Gateway Using storage classes with a File Gateway When you create or update a file share, you have the option to select a storage class for your objects. You can choose the Amazon S3 Standard storage class, or any of the S3 Standard-IA, S3 One Zone-IA, or S3 Intelligent-Tiering storage classes. Objects stored in any of these storage classes can be transitioned to GLACIER using a lifecycle policy. Amazon S3 storage class Considerations Standard Choose Standard to store your frequently accessed files redundantly in multiple Availabil Using storage classes API Version 2013-06-30 364 AWS Storage Gateway Amazon S3 File Gateway User Guide Amazon S3 storage class Considerations ity Zones that are geographically separated. This is the default storage class. See Amazon S3 pricing for more details. Using storage classes with a File Gateway API Version 2013-06-30 365 AWS Storage Gateway Amazon S3 File Gateway User Guide Amazon S3 storage class Considerations S3 Intelligent-Tiering Choose Intelligent-Tiering to optimize storage costs by automatically moving data to the most cost-effective storage access tier. Objects smaller than 128 KB are not eligible for auto tiering in the Intelligent-Tiering storage class. These objects are charged at the frequent access tier rates, and don't incur the monitoring fee charged for auto-tiered objects. S3 Intelligent-Tiering now supports an Archive Access tier and a Deep Archive Access tier. S3 Intelligent-Tiering automatically moves objects that haven’t been accessed for 90 days to the Archive Access tier, and after 180 days without being accessed, to the Deep Archive Access tier. Whenever an object in one of the archive access tiers is restored, the object moves to the Frequent Access tier within a few hours and is ready to be retrieved. This creates timeout errors for users or applications trying to access files through a file share if the object only exists in one of the two archive tiers. Don't use the archive tiers with S3 Intelligent- Tiering if your applications are accessing files through the file shares that are presented by the File Gateway. When file operations that update metadata (such as owner, timestamp, permissions, and ACLs) are performed against files managed by the File Gateway, the existing object is deleted and a new version of the object is created in this Amazon S3 storage class. Validate how file Using storage classes with a File Gateway API Version 2013-06-30 366 AWS Storage Gateway Amazon S3 File Gateway User Guide Amazon S3 storage class Considerations S3 Standard-IA operations impact object creation before using this storage class in production. See Amazon S3 pricing for more details. Choose Standard-IA to store your infrequently accessed files redundantly in multiple Availabil ity Zones that are geographically separated. Objects stored in the Standard-IA storage class can incur additional charges for overwriti ng, deleting, requesting, retrieving, or transitio ning objects between storage classes within 30 days. There is a minimum storage duration of 30 days. Objects deleted before 30 days incur a pro-rated charge equal to the storage charge for the remaining days. Consider how often these objects change, how long you plan to keep these objects, and how often you need to access them. Objects smaller than 128 KB are charged for 128 KB and early deletion fees apply. When file operations that update metadata (such as owner, timestamp, permissions, and ACLs) are performed against files managed by the File Gateway, the existing object is deleted and a new version of the object is created in this Amazon S3 storage class. You should validate how file operations impact object creation before using this storage class in production because early deletion fees apply. See Amazon S3 pricing for more details. Using storage classes with a File Gateway API Version 2013-06-30 367 AWS Storage Gateway Amazon S3 File Gateway User Guide Amazon S3 storage class Considerations S3 One Zone-IA Choose One Zone-IA to store your infrequently accessed files in a single Availability Zone. Objects stored in the One Zone-IA storage class can incur additional charges for overwriti ng, deleting, requesting, retrieving, or transitio ning objects between storage classes within 30 days. There
|
storagegateway-s3file-ug-146
|
storagegateway-s3file-ug.pdf
| 146 |
class. You should validate how file operations impact object creation before using this storage class in production because early deletion fees apply. See Amazon S3 pricing for more details. Using storage classes with a File Gateway API Version 2013-06-30 367 AWS Storage Gateway Amazon S3 File Gateway User Guide Amazon S3 storage class Considerations S3 One Zone-IA Choose One Zone-IA to store your infrequently accessed files in a single Availability Zone. Objects stored in the One Zone-IA storage class can incur additional charges for overwriti ng, deleting, requesting, retrieving, or transitio ning objects between storage classes within 30 days. There is a minimum storage duration of 30 days, and objects deleted before 30 days incur a pro-rated charge equal to the storage charge for the remaining days. Consider how often these objects change, how long you plan to keep these objects, and how often you need to access them. Objects smaller than 128 KB are charged for 128 KB and early deletion fees apply. When file operations that update metadata (such as owner, timestamp, permissions, and ACLs) are performed against files managed by the File Gateway, the existing object is deleted and a new version of the object is created in this Amazon S3 storage class. You should validate how file operations impact object creation before using this storage class in production because early deletion fees apply. See Amazon S3 pricing for more details. Although you can write objects directly from a file share to the S3-Standard-IA, S3-One Zone-IA, or S3 Intelligent-Tiering storage class, we recommend that you use a lifecycle policy to transition your objects rather than write directly from the file share, especially if you're expecting to update or delete the object within 30 days of archiving it. For information about lifecycle policy, see Object lifecycle management. Using storage classes with a File Gateway API Version 2013-06-30 368 AWS Storage Gateway Amazon S3 File Gateway User Guide Using the GLACIER storage class with File Gateway If you transition a file to S3 Glacier through Amazon S3 lifecycle policies, and the file is visible to your file share clients through the cache, you will encounter I/O errors when you update the file. We recommend that you set up CloudWatch Events to receive notification when these I/O errors occur, and use the notification to take action. For example, you can take action to restore the archived object to Amazon S3. After the object is restored to S3, your file share clients can access and update them successfully through the file share. For information about how to restore archived objects, see Restoring archived objects in the Amazon Simple Storage Service User Guide. Important S3 File Gateway does not officially support the S3 Glacier Instant Retrieval storage class. Although you can designate objects in a file share bucket for S3 Glacier Instant Retrieval by using lifecycle policies or direct PUT requests, S3 File Gateway cannot recognize which files are in that storage class, and will perform file operations on them like any other object. Because S3 Glacier Instant Retrieval has higher costs for access than other Amazon S3 storage classes, bulk file operations such as virus scans, rsync, and renames, can result in large Amazon S3 bills if not managed carefully. For this reason, we do not recommend using S3 Glacier Instant Retrieval with S3 File Gateway. Using Kubernetes Container Storage Interface drivers Kubernetes is an open-source system for automating deployment, scaling, and management of containerized applications. In a Kubernetes environment, a container is similar to a VM, but a container has relaxed isolation properties to share the Operating System (OS) among its applications. Therefore, containers are considered to be more lightweight than VMs. Similar to a VM, a container has its own filesystem, a share of allocated CPU, memory, process space, and more. As they are decoupled from the underlying infrastructure, they are portable across clouds and OS distributions. If you have a Kubernetes cluster, you can install and configure Kubernetes Container Storage Interface (CSI) drivers across the instances in your cluster to allow them to use an existing Amazon S3 File Gateway for storage. After you install the CSI drivers for the type of file share that you want to use, you must create one or more storage objects. Depending on the type of provisioning that you want Kubernetes to Using the GLACIER storage class with File Gateway API Version 2013-06-30 369 AWS Storage Gateway Amazon S3 File Gateway User Guide use when your pods request storage, you must create either a single Kubernetes StorageClass object, or both a PersistentVolume object and a PersistentVolumeClaim object to connect your Kubernetes compute pods to your file share. For more information, refer to the Kubernetes online documentation at https://kubernetes.io/docs/concepts/storage/. Topics • Working with SMB CSI drivers • Working with NFS CSI drivers Working
|
storagegateway-s3file-ug-147
|
storagegateway-s3file-ug.pdf
| 147 |
use, you must create one or more storage objects. Depending on the type of provisioning that you want Kubernetes to Using the GLACIER storage class with File Gateway API Version 2013-06-30 369 AWS Storage Gateway Amazon S3 File Gateway User Guide use when your pods request storage, you must create either a single Kubernetes StorageClass object, or both a PersistentVolume object and a PersistentVolumeClaim object to connect your Kubernetes compute pods to your file share. For more information, refer to the Kubernetes online documentation at https://kubernetes.io/docs/concepts/storage/. Topics • Working with SMB CSI drivers • Working with NFS CSI drivers Working with SMB CSI drivers Follow the procedures in this section to install, configure, or delete the CSI drivers that are required to use an SMB file share on an Amazon S3 File Gateway for storage in your Kubernetes cluster. For more information, see the open-source SMB CSI driver documentation on GitHub at https:// github.com/kubernetes-csi/csi-driver-smb/blob/master/docs/install-csi-driver-master.md. Note When you create a PersistentVolume object or a StorageClass object, you can specify a ReclaimPolicy parameter to determine what happens to the external storage when objects are deleted. The SMB CSI driver supports the Retain and Recycle options, but does not currently support a Delete option. Install drivers To install Kubernetes SMB CSI drivers: 1. From a command-line terminal with access to kubectl for your Kubernetes cluster, run the following command: curl -skSL https://raw.githubusercontent.com/kubernetes-csi/csi-driver-smb/master/ deploy/install-driver.sh | bash -s master -- 2. Wait for the previous command to finish, then use the following commands to ensure that the CSI driver pods are running: kubectl -n kube-system get pod -o wide --watch -l app=csi-smb-controller Working with SMB CSI drivers API Version 2013-06-30 370 AWS Storage Gateway Amazon S3 File Gateway User Guide kubectl -n kube-system get pod -o wide --watch -l app=csi-smb-node The output should look similar to the following: NAME READY STATUS RESTARTS AGE IP NODE csi-smb-controller-56bfddd689-dh5tk 4/4 Running 0 35s 10.240.0.19 k8s-agentpool-22533604-0 csi-smb-controller-56bfddd689-8pgr4 4/4 Running 0 35s 10.240.0.35 k8s-agentpool-22533604-1 csi-smb-node-cvgbs 3/3 Running 0 35s 10.240.0.35 k8s-agentpool-22533604-1 csi-smb-node-dr4s4 3/3 Running 0 35s 10.240.0.4 k8s-agentpool-22533604-0 Create an SMB StorageClass object To create a new SMB StorageClass object for your Kubernetes cluster: 1. Create a configuration file named storageclass.yaml with contents similar to the following example. Substitute your own deployment-specific information for the ExampleValues shown. --- apiVersion: storage.k8s.io/v1 kind: StorageClass metadata: name: ExampleStorageClassName provisioner: smb.csi.k8s.io parameters: source: "//gateway-dns-name-or-ip-address/example-share-name" # if csi.storage.k8s.io/provisioner-secret is provided, will create a sub directory # with PV name under source csi.storage.k8s.io/provisioner-secret-name: "examplesmbcreds" csi.storage.k8s.io/provisioner-secret-namespace: "examplenamespace" csi.storage.k8s.io/node-stage-secret-name: "examplesmbcreds" csi.storage.k8s.io/node-stage-secret-namespace: "examplenamespace" Working with SMB CSI drivers API Version 2013-06-30 371 AWS Storage Gateway Amazon S3 File Gateway User Guide volumeBindingMode: Immediate reclaimPolicy: Retain mountOptions: - dir_mode=0777 - file_mode=0777 - uid=1001 - gid=1001 2. From a command-line terminal with access to kubectl and storageclass.yaml, run the following command: kubectl apply -f storageclass.yaml Note You can also create the StorageClass by providing the .yaml configuration text from the previous step to most third-party Kubernetes management and containerization platforms. 3. Configure the pods in your Kubernetes cluster to use the new StorageClass that you created. For more information, refer to the Kubernetes online documentation at https://kubernetes.io/ docs/concepts/storage/. Create SMB PersistentVolume and PersistentVolumeClaim objects To create new SMB PersistentVolume and PersistentVolumeClaim objects: 1. Create two configuration files. One named persistentvolume.yaml, and one named persistentvolumeclaim.yaml. 2. For persistentvolume.yaml, add contents that are similar to the following example. Substitute your own deployment-specific information for the ExampleValues shown. --- apiVersion: v1 kind: PersistentVolume metadata: name: pv-smb-example-name namespace: smb-example-namespace # PersistentVolume and PersistentVolumeClaim must use the same namespace parameter Working with SMB CSI drivers API Version 2013-06-30 372 Amazon S3 File Gateway User Guide AWS Storage Gateway spec: capacity: storage: 100Gi accessModes: - ReadWriteMany persistentVolumeReclaimPolicy: Retain mountOptions: - dir_mode=0777 - file_mode=0777 - vers=3.0 csi: driver: smb.csi.k8s.io readOnly: false volumeHandle: examplehandle # make sure it's a unique id in the cluster volumeAttributes: source: "//gateway-dns-name-or-ip-address/example-share-name" nodeStageSecretRef: name: example-smbcreds namespace: smb-example-namespace 3. For persistentvolumeclaim.yaml, add contents that are similar to the following example. Substitute your own deployment-specific information for the ExampleValues shown. --- kind: PersistentVolumeClaim apiVersion: v1 metadata: name: examplename-pvc-smb-static namespace: smb-example-namespace # PersistentVolume and PersistentVolumeClaim must use the same namespace parameter spec: accessModes: - ReadWriteMany resources: requests: storage: 10Gi volumeName: pv-smb-example-name # make sure specfied volumeName matches the name of the PersistentVolume you created storageClassName: "" 4. From a command-line terminal with access to kubectl and both of the .yaml files that you created, run the following commands: Working with SMB CSI drivers API Version 2013-06-30 373 AWS Storage Gateway Amazon S3 File Gateway User Guide kubectl apply -f persistentvolume.yaml kubectl apply -f persistentvolumeclaim.yaml Note You can also create the PersistentVolume and PersistentVolumeClaim objects by providing the .yaml configuration text from the previous step to most third-party Kubernetes management and containerization platforms. 5. Configure the pods in your Kubernetes cluster to use the new PersistentVolumeClaim that you
|
storagegateway-s3file-ug-148
|
storagegateway-s3file-ug.pdf
| 148 |
the name of the PersistentVolume you created storageClassName: "" 4. From a command-line terminal with access to kubectl and both of the .yaml files that you created, run the following commands: Working with SMB CSI drivers API Version 2013-06-30 373 AWS Storage Gateway Amazon S3 File Gateway User Guide kubectl apply -f persistentvolume.yaml kubectl apply -f persistentvolumeclaim.yaml Note You can also create the PersistentVolume and PersistentVolumeClaim objects by providing the .yaml configuration text from the previous step to most third-party Kubernetes management and containerization platforms. 5. Configure the pods in your Kubernetes cluster to use the new PersistentVolumeClaim that you created. For more information, refer to the Kubernetes online documentation at https:// kubernetes.io/docs/concepts/storage/. Uninstall drivers To uninstall the Kubernetes SMB CSI drivers: • From a command-line terminal with access to kubectl for your Kubernetes cluster, run the following command: curl -skSL https://raw.githubusercontent.com/kubernetes-csi/csi-driver-smb/master/ deploy/uninstall-driver.sh | bash -s -- Working with NFS CSI drivers Follow the procedures in this section to install, configure, or delete the CSI drivers that are required to use an NFS file share on an Amazon S3 File Gateway for storage in your Kubernetes cluster. For more information, see the open-source NFS CSI driver documentation on GitHub at https:// github.com/kubernetes-csi/csi-driver-nfs/blob/master/docs/install-csi-driver-master.md. Install drivers To install Kubernetes NFS CSI drivers: 1. From a command-line terminal with access to kubectl for your Kubernetes cluster, run the following command: Working with NFS CSI drivers API Version 2013-06-30 374 AWS Storage Gateway Amazon S3 File Gateway User Guide curl -skSL https://raw.githubusercontent.com/kubernetes-csi/csi-driver-nfs/master/ deploy/install-driver.sh | bash -s master -- 2. Wait for the previous command to finish, then use the following commands to ensure that the CSI driver pods are running: kubectl -n kube-system get pod -o wide -l app=csi-nfs-controller kubectl -n kube-system get pod -o wide -l app=csi-nfs-node The output should look similar to the following: NAME READY STATUS RESTARTS AGE IP NODE csi-nfs-controller-56bfddd689-dh5tk 4/4 Running 0 35s 10.240.0.19 k8s-agentpool-22533604-0 csi-nfs-controller-56bfddd689-8pgr4 4/4 Running 0 35s 10.240.0.35 k8s-agentpool-22533604-1 csi-nfs-node-cvgbs 3/3 Running 0 35s 10.240.0.35 k8s-agentpool-22533604-1 csi-nfs-node-dr4s4 3/3 Running 0 35s 10.240.0.4 k8s-agentpool-22533604-0 Create an NFS StorageClass object To create an NFS StorageClass object for your Kubernetes cluster: 1. Create a configuration file named storageclass.yaml with contents that are similar to the following example. Substitute your own deployment-specific information for the ExampleValues shown. --- apiVersion: storage.k8s.io/v1 kind: StorageClass metadata: name: example-nfs-classname namespace: example-namespace provisioner: nfs.csi.k8s.io parameters: Working with NFS CSI drivers API Version 2013-06-30 375 AWS Storage Gateway Amazon S3 File Gateway User Guide server: gateway-dns-name-or-ip-address share: /example-share-name reclaimPolicy: Retain volumeBindingMode: Immediate mountOptions: - hard - nfsvers=4.1 2. From a command-line terminal with access to kubectl and storageclass.yaml, run the following command: kubectl apply -f storageclass.yaml Note You can also create the StorageClass by providing the .yaml configuration text from the previous step to most third-party Kubernetes management and containerization platforms. 3. Configure the pods in your Kubernetes cluster to use the new StorageClass object that you created. For more information, refer to the Kubernetes online documentation at https:// kubernetes.io/docs/concepts/storage/. Create NFS PersistentVolume and PersistentVolumeClaim objects To create new NFS PersistentVolume and PersistentVolumeClaim objects: 1. Create two configuration files named persistentvolume.yaml and persistentvolumeclaim.yaml. 2. For persistentvolume.yaml, add contents that are similar to the following example. Substitute your own deployment-specific information for the ExampleValues shown. --- apiVersion: v1 kind: PersistentVolume metadata: name: pv-nfs-examplename spec: capacity: Working with NFS CSI drivers API Version 2013-06-30 376 AWS Storage Gateway Amazon S3 File Gateway User Guide storage: 10Gi accessModes: - ReadWriteMany persistentVolumeReclaimPolicy: Retain mountOptions: - hard - nolock - nfsvers=4.1 csi: driver: nfs.csi.k8s.io readOnly: false volumeHandle: unique-volumeid-example # make sure it's a unique id in the cluster volumeAttributes: server: gateway-dns-name-or-ip-address share: /example-share-name 3. For persistentvolumeclaim.yaml, add contents that are similar to the following example. Substitute your own deployment-specific information for the ExampleValues shown. --- kind: PersistentVolumeClaim apiVersion: v1 metadata: name: examplename-pvc-nfs-static spec: accessModes: - ReadWriteMany resources: requests: storage: 10Gi volumeName: pv-nfs-examplename # make sure specfied volumeName matches the name of the PersistentVolume you created storageClassName: "" 4. From a command-line terminal with access to kubectl and both .yaml files, run the following commands: kubectl apply -f persistentvolume.yaml kubectl apply -f persistentvolumeclaim.yaml Working with NFS CSI drivers API Version 2013-06-30 377 AWS Storage Gateway Amazon S3 File Gateway User Guide Note You can also create the PersistentVolume and PersistentVolumeClaim objects by providing the .yaml configuration text from the previous step to most third-party Kubernetes management and containerization platforms. 5. Configure the pods in your Kubernetes cluster to use the new PersistentVolumeClaim object that you created. For more information, refer to the Kubernetes online documentation at https://kubernetes.io/docs/concepts/storage/. Uninstall drivers To uninstall Kubernetes NFS CSI drivers: • From a command-line terminal with access to kubectl for your Kubernetes cluster, run the following command: curl -skSL https://raw.githubusercontent.com/kubernetes-csi/csi-driver-nfs/master/ deploy/uninstall-driver.sh | bash -s master -- AWS Storage Gateway Terraform module HashiCorpTerraform is an open-source Infrastructure as
|
storagegateway-s3file-ug-149
|
storagegateway-s3file-ug.pdf
| 149 |
You can also create the PersistentVolume and PersistentVolumeClaim objects by providing the .yaml configuration text from the previous step to most third-party Kubernetes management and containerization platforms. 5. Configure the pods in your Kubernetes cluster to use the new PersistentVolumeClaim object that you created. For more information, refer to the Kubernetes online documentation at https://kubernetes.io/docs/concepts/storage/. Uninstall drivers To uninstall Kubernetes NFS CSI drivers: • From a command-line terminal with access to kubectl for your Kubernetes cluster, run the following command: curl -skSL https://raw.githubusercontent.com/kubernetes-csi/csi-driver-nfs/master/ deploy/uninstall-driver.sh | bash -s master -- AWS Storage Gateway Terraform module HashiCorpTerraform is an open-source Infrastructure as Code (IaC) engine developed using the HashiCorp Configuration Language (HCL). Terraform provides a consistent command line interface (CLI) workflow that, in conjunction with Amazon S3 File Gateway for the back-end infrastructure, can manage hundreds of cloud services and codify cloud APIs into declarative configuration files. You can use Terraform to safely deploy an Amazon S3 File Gateway as a virtual machine (VM) in your on-premises virtual infrastructure. Terraform provides automation for on-premises virtual infrastructure. See Automate Amazon S3 File Gateway deployments in VMware with Terraform by HashiCorp for information about quickly deploying an Amazon S3 File Gateway using Terraform within an on-premises VMware virtual environment. Note You might need to configure Terraform to obtain the latest version of the AWS Storage Gateway machine image for your preferred hypervisor platform. Storage Gateway machine Terraform module API Version 2013-06-30 378 AWS Storage Gateway Amazon S3 File Gateway User Guide images use the following naming convention. The version number appended to the image name changes with each version release. aws-storage-gateway-FILE_S3-1.25.0 This automation provides you with a customizable Terraform module that you can use to provision an Amazon S3 File Gateway with all of the resources and dependencies needed to fully deploy the gateway and file shares in your VM environment. The Terraform module provisions the gateway VM, activates the gateway, configures the cache disk, joins the gateway to a domain, creates the Amazon S3 buckets, creates the file shares, and maps them to buckets. For a complete example of a repository that contains Terraform code to create the resources required to run Amazon S3 File Gateway on premises, see the Terraform Storage Gateway module source code on GitHub. Note The Amazon S3 File Gateway module for Terraform is a community supported effort. It is not part of an AWS service. Best-effort support is provided by the AWS Storage community. Terraform module API Version 2013-06-30 379 AWS Storage Gateway Amazon S3 File Gateway User Guide API Reference for Storage Gateway In addition to using the console, you can use the AWS Storage Gateway API to programmatically configure and manage your gateways. This section describes the AWS Storage Gateway operations, request signing for authentication and the error handling. For information about the regions and endpoints available for Storage Gateway, see AWS Storage Gateway Endpoints and Quotas in the AWS General Reference. Note You can also use the AWS SDKs when developing applications with Storage Gateway. The AWS SDKs for Java, .NET, and PHP wrap the underlying Storage Gateway API, simplifying your programming tasks. For information about downloading the SDK libraries, see Sample Code Libraries. Topics • AWS Storage Gateway Required Request Headers • Signing Requests • Error Responses • Storage Gateway API Actions AWS Storage Gateway Required Request Headers This section describes the required headers that you must send with every POST request to AWS Storage Gateway. You include HTTP headers to identify key information about the request including the operation you want to invoke, the date of the request, and information that indicates the authorization of you as the sender of the request. Headers are case insensitive and the order of the headers is not important. The following example shows headers that are used in the ActivateGateway operation. POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com Content-Type: application/x-amz-json-1.1 Required Request Headers API Version 2013-06-30 380 AWS Storage Gateway Amazon S3 File Gateway User Guide Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/ storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2 x-amz-date: 20120912T120000Z x-amz-target: StorageGateway_20120630.ActivateGateway The following are the headers that must include with your POST requests to AWS Storage Gateway. Headers shown below that begin with "x-amz" are AWS-specific headers. All other headers listed are common header used in HTTP transactions. Header Description Authorization The authorization header contains several of pieces of information about the request that allow AWS Storage Gateway to determine if the request is a valid action for the requester. The format of this header is as follows (line breaks added for readability): Authorization: AWS4-HMAC_SHA456 Credentials= YourAccessKey /yyymmdd/region/storagegateway/aw s4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-targ et, Signature= CalculatedSignature In the preceding syntax, you specify YourAccessKey, the year, month, and day (yyyymmdd), the region, and the CalculatedSignature. The format of the authorization header is dictated by the requirements of the AWS V4 Signing process. The details of signing are discussed
|
storagegateway-s3file-ug-150
|
storagegateway-s3file-ug.pdf
| 150 |
used in HTTP transactions. Header Description Authorization The authorization header contains several of pieces of information about the request that allow AWS Storage Gateway to determine if the request is a valid action for the requester. The format of this header is as follows (line breaks added for readability): Authorization: AWS4-HMAC_SHA456 Credentials= YourAccessKey /yyymmdd/region/storagegateway/aw s4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-targ et, Signature= CalculatedSignature In the preceding syntax, you specify YourAccessKey, the year, month, and day (yyyymmdd), the region, and the CalculatedSignature. The format of the authorization header is dictated by the requirements of the AWS V4 Signing process. The details of signing are discussed in the topic Signing Requests. Content-Type Use application/x-amz-json-1.1 requests to AWS Storage Gateway. as the content type for all Content-Type: application/x-amz-json-1.1 Host Use the host header to specify the AWS Storage Gateway endpoint where you send your request. For example, storagegateway.us- Required Request Headers API Version 2013-06-30 381 AWS Storage Gateway Amazon S3 File Gateway User Guide Header Description x-amz-date east-2.amazonaws.com region. For more information about the endpoints available for AWS Storage Gateway, see AWS Storage Gateway Endpoints and Quotas in is the endpoint for the US East (Ohio) the AWS General Reference. Host: storagegateway. region.amazonaws.com You must provide the time stamp in either the HTTP Date header or the AWS x-amz-date header. (Some HTTP client libraries don't let you set the Date header.) When an x-amz-date header is present, the AWS Storage Gateway ignores any Date header during the request authentication. The x-amz-date format must be ISO8601 Basic in the YYYYMMDD'T'HHMMSS'Z' format. If both the Date and x-amz- date header are used, the format of the Date header does not have to be ISO8601. x-amz-date: YYYYMMDD'T'HHMMSS'Z' x-amz-target This header specifies the version of the API and the operation that you are requesting. The target header values are formed by concatenating the API version with the API name and are in the following format. x-amz-target: StorageGateway_ APIversion .operationName The operationName value (e.g. "ActivateGateway") can be found from the API list, API Reference for Storage Gateway. Signing Requests Storage Gateway requires that you authenticate every request you send by signing the request. To sign a request, you calculate a digital signature using a cryptographic hash function. A cryptographic hash is a function that returns a unique hash value based on the input. The input to Signing Requests API Version 2013-06-30 382 AWS Storage Gateway Amazon S3 File Gateway User Guide the hash function includes the text of your request and your secret access key. The hash function returns a hash value that you include in the request as your signature. The signature is part of the Authorization header of your request. After receiving your request, Storage Gateway recalculates the signature using the same hash function and input that you used to sign the request. If the resulting signature matches the signature in the request, Storage Gateway processes the request. Otherwise, the request is rejected. Storage Gateway supports authentication using AWS Signature Version 4. The process for calculating a signature can be broken into three tasks: • Task 1: Create a Canonical Request Rearrange your HTTP request into a canonical format. Using a canonical form is necessary because Storage Gateway uses the same canonical form when it recalculates a signature to compare with the one you sent. • Task 2: Create a String to Sign Create a string that you will use as one of the input values to your cryptographic hash function. The string, called the string to sign, is a concatenation of the name of the hash algorithm, the request date, a credential scope string, and the canonicalized request from the previous task. The credential scope string itself is a concatenation of date, region, and service information. • Task 3: Create a Signature Create a signature for your request by using a cryptographic hash function that accepts two input strings: your string to sign and a derived key. The derived key is calculated by starting with your secret access key and using the credential scope string to create a series of Hash-based Message Authentication Codes (HMACs). Example Signature Calculation The following example walks you through the details of creating a signature for ListGateways. The example could be used as a reference to check your signature calculation method. The example assumes the following: • The time stamp of the request is "Mon, 10 Sep 2012 00:00:00" GMT. • The endpoint is the US East (Ohio) region. Example Signature Calculation API Version 2013-06-30 383 AWS Storage Gateway Amazon S3 File Gateway User Guide The general request syntax (including the JSON body) is: POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120910T000000Z Authorization: SignatureToBeCalculated Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20120630.ListGateways {} The canonical form of the request calculated for Task 1: Create a Canonical Request is: POST / content-type:application/x-amz-json-1.1 host:storagegateway.us-east-2.amazonaws.com x-amz-date:20120910T000000Z x-amz-target:StorageGateway_20120630.ListGateways content-type;host;x-amz-date;x-amz-target 44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a The last line
|
storagegateway-s3file-ug-151
|
storagegateway-s3file-ug.pdf
| 151 |
reference to check your signature calculation method. The example assumes the following: • The time stamp of the request is "Mon, 10 Sep 2012 00:00:00" GMT. • The endpoint is the US East (Ohio) region. Example Signature Calculation API Version 2013-06-30 383 AWS Storage Gateway Amazon S3 File Gateway User Guide The general request syntax (including the JSON body) is: POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120910T000000Z Authorization: SignatureToBeCalculated Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20120630.ListGateways {} The canonical form of the request calculated for Task 1: Create a Canonical Request is: POST / content-type:application/x-amz-json-1.1 host:storagegateway.us-east-2.amazonaws.com x-amz-date:20120910T000000Z x-amz-target:StorageGateway_20120630.ListGateways content-type;host;x-amz-date;x-amz-target 44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a The last line of the canonical request is the hash of the request body. Also, note the empty third line in the canonical request. This is because there are no query parameters for this API (or any Storage Gateway APIs). The string to sign for Task 2: Create a String to Sign is: AWS4-HMAC-SHA256 20120910T000000Z 20120910/us-east-2/storagegateway/aws4_request 92c0effa6f9224ac752ca179a04cecbede3038b0959666a8160ab452c9e51b3e The first line of the string to sign is the algorithm, the second line is the time stamp, the third line is the credential scope, and the last line is a hash of the canonical request from Task 1. For Task 3: Create a Signature, the derived key can be represented as: Example Signature Calculation API Version 2013-06-30 384 AWS Storage Gateway Amazon S3 File Gateway User Guide derived key = HMAC(HMAC(HMAC(HMAC("AWS4" + YourSecretAccessKey,"20120910"),"us- east-2"),"storagegateway"),"aws4_request") If the secret access key, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY, is used, then the calculated signature is: 6d4c40b8f2257534dbdca9f326f147a0a7a419b63aff349d9d9c737c9a0f4c81 The final step is to construct the Authorization header. For the demonstration access key AKIAIOSFODNN7EXAMPLE, the header (with line breaks added for readability) is: Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120910/us-east-2/ storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=6d4c40b8f2257534dbdca9f326f147a0a7a419b63aff349d9d9c737c9a0f4c81 Error Responses Topics • Exceptions • Operation Error Codes • Error Responses This section provides reference information about AWS Storage Gateway errors. These errors are represented by an error exception and an operation error code. For example, the error exception InvalidSignatureException is returned by any API response if there is a problem with the request signature. However, the operation error code ActivationKeyInvalid is returned only for the ActivateGateway API. Depending on the type of error, Storage Gateway may return only just an exception, or it may return both an exception and an operation error code. Examples of error responses are shown in the Error Responses. Error Responses API Version 2013-06-30 385 AWS Storage Gateway Exceptions Amazon S3 File Gateway User Guide The following table lists AWS Storage Gateway API exceptions. When an AWS Storage Gateway operation returns an error response, the response body contains one of these exceptions. The InternalServerError and InvalidGatewayRequestException return one of the operation error codes Operation Error Codes message codes that give the specific operation error code. Exception Message HTTP Status Code IncompleteSignatur The specified signature is incomplete. 400 Bad Request eException InternalFailure The request processing has failed due to some unknown error, exception or 500 Internal Server Error failure. InternalServerError One of the operation error code messages Operation Error Codes. 500 Internal Server Error InvalidAction The requested action or operation is invalid. 400 Bad Request InvalidClientTokenId The X.509 certificate or AWS Access Key ID provided does not exist in our 403 Forbidden records. InvalidGatewayRequ estException One of the operation error code messages in Operation Error Codes. 400 Bad Request InvalidSignatureEx ception The request signature we calculate d does not match the signature you provided. Check your AWS Access Key and signing method. 400 Bad Request MissingAction The request is missing an action or operation parameter. 400 Bad Request Exceptions API Version 2013-06-30 386 AWS Storage Gateway Amazon S3 File Gateway User Guide Exception Message HTTP Status Code MissingAuthenticat ionToken The request must contain either a valid (registered) AWS Access Key ID 403 Forbidden RequestExpired SerializationException or X.509 certificate. The request is past the expiration date or the request date (either with 15 minute padding), or the request date occurs more than 15 minutes in the future. An error occurred during serializa tion. Check that your JSON payload is well-formed. 400 Bad Request 400 Bad Request ServiceUnavailable The request has failed due to a temporary failure of the server. 503 Service Unavailable SubscriptionRequir edException The AWS Access Key Id needs a subscription for the service. 400 Bad Request ThrottlingException Rate exceeded. 400 Bad Request TooManyRequests Too many requests. UnknownOperationEx ception An unknown operation was specified. Valid operations are listed in Storage Gateway API Actions. 429 Too Many Requests 400 Bad Request UnrecognizedClient Exception The security token included in the request is invalid. 400 Bad Request ValidationException The value of an input parameter is bad or out of range. 400 Bad Request Exceptions API Version 2013-06-30 387 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Codes The following table shows the mapping between AWS Storage Gateway operation error codes and APIs that can return the codes. All operation error codes are
|
storagegateway-s3file-ug-152
|
storagegateway-s3file-ug.pdf
| 152 |
Request TooManyRequests Too many requests. UnknownOperationEx ception An unknown operation was specified. Valid operations are listed in Storage Gateway API Actions. 429 Too Many Requests 400 Bad Request UnrecognizedClient Exception The security token included in the request is invalid. 400 Bad Request ValidationException The value of an input parameter is bad or out of range. 400 Bad Request Exceptions API Version 2013-06-30 387 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Codes The following table shows the mapping between AWS Storage Gateway operation error codes and APIs that can return the codes. All operation error codes are returned with one of two general exceptions—InternalServerError and InvalidGatewayRequestException—described in Exceptions. Operation Error Code Message Operations That Return this Error Code ActivationKeyExpired The specified activatio n key has expired. ActivateGateway ActivationKeyInvalid The specified activatio n key is invalid. ActivateGateway ActivationKeyNotFound The specified activatio n key was not found. ActivateGateway BandwidthThrottleS cheduleNotFound The specified bandwidth throttle was not found. DeleteBandwidthRateLimit CannotExportSnapshot The specified snapshot cannot be exported. CreateCachediSCSIVolume CreateStorediSCSIVolume InitiatorNotFound DiskAlreadyAllocated The specified initiator was not found. The specified disk is already allocated. DeleteChapCredentials AddCache AddUploadBuffer AddWorkingStorage CreateStorediSCSIVolume DiskDoesNotExist The specified disk does not exist. AddCache AddUploadBuffer Operation Error Codes API Version 2013-06-30 388 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message DiskSizeNotGigAligned DiskSizeGreaterTha nVolumeMaxSize DiskSizeLessThanVo lumeSize DuplicateCertifica teInfo FileSystemAssociationEndpoi ntConfigurationConflict FileSystemAssociationEndpoi ntIpAddressAlreadyInUse FileSystemAssociationEndpoi ntIpAddressMissing The specified disk is not gigabyte-aligned. The specified disk size is greater than the maximum volume size. The specified disk size is less than the volume size. The specified certifica te information is a duplicate. Existing File System Association endpoint configuration conflicts with specified configuration. The specified endpoint IP address is already in use. File System Associati on Endpoint IP address is missing. Operations That Return this Error Code AddWorkingStorage CreateStorediSCSIVolume CreateStorediSCSIVolume CreateStorediSCSIVolume CreateStorediSCSIVolume ActivateGateway AssociateFileSystem AssociateFileSystem AssociateFileSystem Operation Error Codes API Version 2013-06-30 389 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message FileSystemAssociationNotFound The specified file system association was not found. Operations That Return this Error Code UpdateFileSystemAssociation DisassociateFileSystem DescribeFileSystemAssociations FileSystemNotFound The specified file system was not found. AssociateFileSystem Operation Error Codes API Version 2013-06-30 390 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code GatewayInternalError A gateway internal error occurred. AddCache AddUploadBuffer AddWorkingStorage CreateCachediSCSIVolume CreateSnapshot CreateStorediSCSIVolume CreateSnapshotFromVolumeRec overyPoint DeleteBandwidthRateLimit DeleteChapCredentials DeleteVolume DescribeBandwidthRateLimit DescribeCache DescribeCachediSCSIVolumes DescribeChapCredentials DescribeGatewayInformation DescribeMaintenanceStartTime DescribeSnapshotSchedule DescribeStorediSCSIVolumes DescribeWorkingStorage ListLocalDisks Operation Error Codes API Version 2013-06-30 391 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code ListVolumes ListVolumeRecoveryPoints ShutdownGateway StartGateway UpdateBandwidthRateLimit UpdateChapCredentials UpdateMaintenanceStartTime UpdateGatewaySoftwareNow UpdateSnapshotSchedule Operation Error Codes API Version 2013-06-30 392 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code GatewayNotConnected The specified gateway is not connected. AddCache AddUploadBuffer AddWorkingStorage CreateCachediSCSIVolume CreateSnapshot CreateStorediSCSIVolume CreateSnapshotFromVolumeRec overyPoint DeleteBandwidthRateLimit DeleteChapCredentials DeleteVolume DescribeBandwidthRateLimit DescribeCache DescribeCachediSCSIVolumes DescribeChapCredentials DescribeGatewayInformation DescribeMaintenanceStartTime DescribeSnapshotSchedule DescribeStorediSCSIVolumes DescribeWorkingStorage ListLocalDisks Operation Error Codes API Version 2013-06-30 393 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code ListVolumes ListVolumeRecoveryPoints ShutdownGateway StartGateway UpdateBandwidthRateLimit UpdateChapCredentials UpdateMaintenanceStartTime UpdateGatewaySoftwareNow UpdateSnapshotSchedule Operation Error Codes API Version 2013-06-30 394 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code GatewayNotFound The specified gateway was not found. AddCache AddUploadBuffer AddWorkingStorage CreateCachediSCSIVolume CreateSnapshot CreateSnapshotFromVolumeRec overyPoint CreateStorediSCSIVolume DeleteBandwidthRateLimit DeleteChapCredentials DeleteGateway DeleteVolume DescribeBandwidthRateLimit DescribeCache DescribeCachediSCSIVolumes DescribeChapCredentials DescribeGatewayInformation DescribeMaintenanceStartTime DescribeSnapshotSchedule DescribeStorediSCSIVolumes DescribeWorkingStorage Operation Error Codes API Version 2013-06-30 395 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code ListLocalDisks ListVolumes ListVolumeRecoveryPoints ShutdownGateway StartGateway UpdateBandwidthRateLimit UpdateChapCredentials UpdateMaintenanceStartTime UpdateGatewaySoftwareNow UpdateSnapshotSchedule Operation Error Codes API Version 2013-06-30 396 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code GatewayProxyNetwor kConnectionBusy The specified gateway proxy network connection is busy. AddCache AddUploadBuffer AddWorkingStorage CreateCachediSCSIVolume CreateSnapshot CreateSnapshotFromVolumeRec overyPoint CreateStorediSCSIVolume DeleteBandwidthRateLimit DeleteChapCredentials DeleteVolume DescribeBandwidthRateLimit DescribeCache DescribeCachediSCSIVolumes DescribeChapCredentials DescribeGatewayInformation DescribeMaintenanceStartTime DescribeSnapshotSchedule DescribeStorediSCSIVolumes DescribeWorkingStorage ListLocalDisks Operation Error Codes API Version 2013-06-30 397 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code ListVolumes ListVolumeRecoveryPoints ShutdownGateway StartGateway UpdateBandwidthRateLimit UpdateChapCredentials UpdateMaintenanceStartTime UpdateGatewaySoftwareNow UpdateSnapshotSchedule Operation Error Codes API Version 2013-06-30 398 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code InternalError An internal error occurred. ActivateGateway AddCache AddUploadBuffer AddWorkingStorage CreateCachediSCSIVolume CreateSnapshot CreateSnapshotFromVolumeRec overyPoint CreateStorediSCSIVolume DeleteBandwidthRateLimit DeleteChapCredentials DeleteGateway DeleteVolume DescribeBandwidthRateLimit DescribeCache DescribeCachediSCSIVolumes DescribeChapCredentials DescribeGatewayInformation DescribeMaintenanceStartTime DescribeSnapshotSchedule DescribeStorediSCSIVolumes Operation Error Codes API Version 2013-06-30 399 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code DescribeWorkingStorage ListLocalDisks ListGateways ListVolumes ListVolumeRecoveryPoints ShutdownGateway StartGateway UpdateBandwidthRateLimit UpdateChapCredentials
|
storagegateway-s3file-ug-153
|
storagegateway-s3file-ug.pdf
| 153 |
Return this Error Code ListVolumes ListVolumeRecoveryPoints ShutdownGateway StartGateway UpdateBandwidthRateLimit UpdateChapCredentials UpdateMaintenanceStartTime UpdateGatewaySoftwareNow UpdateSnapshotSchedule Operation Error Codes API Version 2013-06-30 398 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code InternalError An internal error occurred. ActivateGateway AddCache AddUploadBuffer AddWorkingStorage CreateCachediSCSIVolume CreateSnapshot CreateSnapshotFromVolumeRec overyPoint CreateStorediSCSIVolume DeleteBandwidthRateLimit DeleteChapCredentials DeleteGateway DeleteVolume DescribeBandwidthRateLimit DescribeCache DescribeCachediSCSIVolumes DescribeChapCredentials DescribeGatewayInformation DescribeMaintenanceStartTime DescribeSnapshotSchedule DescribeStorediSCSIVolumes Operation Error Codes API Version 2013-06-30 399 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code DescribeWorkingStorage ListLocalDisks ListGateways ListVolumes ListVolumeRecoveryPoints ShutdownGateway StartGateway UpdateBandwidthRateLimit UpdateChapCredentials UpdateMaintenanceStartTime UpdateGatewayInformation UpdateGatewaySoftwareNow UpdateSnapshotSchedule Operation Error Codes API Version 2013-06-30 400 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code InvalidParameters The specified request contains invalid parameters. ActivateGateway AddCache AddUploadBuffer AddWorkingStorage CreateCachediSCSIVolume CreateSnapshot CreateSnapshotFromVolumeRec overyPoint CreateStorediSCSIVolume DeleteBandwidthRateLimit DeleteChapCredentials DeleteGateway DeleteVolume DescribeBandwidthRateLimit DescribeCache DescribeCachediSCSIVolumes DescribeChapCredentials DescribeGatewayInformation DescribeMaintenanceStartTime DescribeSnapshotSchedule DescribeStorediSCSIVolumes Operation Error Codes API Version 2013-06-30 401 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code DescribeWorkingStorage ListLocalDisks ListGateways ListVolumes ListVolumeRecoveryPoints ShutdownGateway StartGateway UpdateBandwidthRateLimit UpdateChapCredentials UpdateMaintenanceStartTime UpdateGatewayInformation UpdateGatewaySoftwareNow UpdateSnapshotSchedule LocalStorageLimitE xceeded The local storage limit was exceeded. AddCache AddUploadBuffer AddWorkingStorage LunInvalid The specified LUN is invalid. CreateStorediSCSIVolume Operation Error Codes API Version 2013-06-30 402 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message MaximumVolumeCount Exceeded The maximum volume count was exceeded. Operations That Return this Error Code CreateCachediSCSIVolume CreateStorediSCSIVolume DescribeCachediSCSIVolumes DescribeStorediSCSIVolumes NetworkConfigurati onChanged The gateway network configuration has changed. CreateCachediSCSIVolume CreateStorediSCSIVolume Operation Error Codes API Version 2013-06-30 403 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code NotSupported The specified operation is not supported. ActivateGateway AddCache AddUploadBuffer AddWorkingStorage CreateCachediSCSIVolume CreateSnapshot CreateSnapshotFromVolumeRec overyPoint CreateStorediSCSIVolume DeleteBandwidthRateLimit DeleteChapCredentials DeleteGateway DeleteVolume DescribeBandwidthRateLimit DescribeCache DescribeCachediSCSIVolumes DescribeChapCredentials DescribeGatewayInformation DescribeMaintenanceStartTime DescribeSnapshotSchedule DescribeStorediSCSIVolumes Operation Error Codes API Version 2013-06-30 404 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code DescribeWorkingStorage ListLocalDisks ListGateways ListVolumes ListVolumeRecoveryPoints ShutdownGateway StartGateway UpdateBandwidthRateLimit UpdateChapCredentials UpdateMaintenanceStartTime UpdateGatewayInformation UpdateGatewaySoftwareNow UpdateSnapshotSchedule OutdatedGateway The specified gateway is out of date. ActivateGateway SnapshotInProgress Exception The specified snapshot is in progress. DeleteVolume SnapshotIdInvalid The specified snapshot is invalid. CreateCachediSCSIVolume CreateStorediSCSIVolume StagingAreaFull The staging area is full. CreateCachediSCSIVolume CreateStorediSCSIVolume Operation Error Codes API Version 2013-06-30 405 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code TargetAlreadyExists TargetInvalid The specified target already exists. CreateCachediSCSIVolume CreateStorediSCSIVolume The specified target is invalid. CreateCachediSCSIVolume CreateStorediSCSIVolume DeleteChapCredentials DescribeChapCredentials UpdateChapCredentials TargetNotFound The specified target was not found. CreateCachediSCSIVolume CreateStorediSCSIVolume DeleteChapCredentials DescribeChapCredentials DeleteVolume UpdateChapCredentials Operation Error Codes API Version 2013-06-30 406 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message UnsupportedOperati onForGatewayType The specified operation is not valid for the type of the gateway. Operations That Return this Error Code AddCache AddWorkingStorage CreateCachediSCSIVolume CreateSnapshotFromVolumeRec overyPoint CreateStorediSCSIVolume DeleteSnapshotSchedule DescribeCache DescribeCachediSCSIVolumes DescribeStorediSCSIVolumes DescribeUploadBuffer DescribeWorkingStorage ListVolumeRecoveryPoints VolumeAlreadyExists The specified volume already exists. CreateCachediSCSIVolume CreateStorediSCSIVolume VolumeIdInvalid VolumeInUse The specified volume is invalid. DeleteVolume The specified volume is already in use. DeleteVolume Operation Error Codes API Version 2013-06-30 407 AWS Storage Gateway Amazon S3 File Gateway User Guide Operation Error Code Message Operations That Return this Error Code VolumeNotFound The specified volume was not found. CreateSnapshot CreateSnapshotFromVolumeRec overyPoint DeleteVolume DescribeCachediSCSIVolumes DescribeSnapshotSchedule DescribeStorediSCSIVolumes UpdateSnapshotSchedule VolumeNotReady The specified volume is not ready. CreateSnapshot CreateSnapshotFromVolumeRec overyPoint Error Responses When there is an error, the response header information contains: • Content-Type: application/x-amz-json-1.1 • An appropriate 4xx or 5xx HTTP status code The body of an error response contains information about the error that occurred. The following sample error response shows the output syntax of response elements common to all error responses. { "__type": "String", "message": "String", "error": { "errorCode": "String", Error Responses API Version 2013-06-30 408 AWS Storage Gateway Amazon S3 File Gateway User Guide "errorDetails": "String" } } The following table explains the JSON error response fields shown in the preceding syntax. __type One of the exceptions from Exceptions. Type: String error Contains API-specific error details. In general errors (i.e., not specific to any API), this error information is not shown. Type: Collection errorCode One of the operation error codes . Type: String errorDetails This field is not used in the current version of the API. Type: String message One of the operation error code messages. Type: String Error Response Examples The following JSON body is returned if you use the DescribeStorediSCSIVolumes API and specify a gateway ARN request input that does not exist. { "__type": "InvalidGatewayRequestException", Error Responses API Version 2013-06-30 409 AWS Storage Gateway Amazon S3 File Gateway User Guide "message": "The specified volume was not found.", "error": { "errorCode": "VolumeNotFound" } } The following JSON body is
|
storagegateway-s3file-ug-154
|
storagegateway-s3file-ug.pdf
| 154 |
shown. Type: Collection errorCode One of the operation error codes . Type: String errorDetails This field is not used in the current version of the API. Type: String message One of the operation error code messages. Type: String Error Response Examples The following JSON body is returned if you use the DescribeStorediSCSIVolumes API and specify a gateway ARN request input that does not exist. { "__type": "InvalidGatewayRequestException", Error Responses API Version 2013-06-30 409 AWS Storage Gateway Amazon S3 File Gateway User Guide "message": "The specified volume was not found.", "error": { "errorCode": "VolumeNotFound" } } The following JSON body is returned if Storage Gateway calculates a signature that does not match the signature sent with a request. { "__type": "InvalidSignatureException", "message": "The request signature we calculated does not match the signature you provided." } Storage Gateway API Actions For a list of Storage Gateway operations, see Actions in the AWS Storage Gateway API Reference. Actions API Version 2013-06-30 410 AWS Storage Gateway Amazon S3 File Gateway User Guide Document history for the Amazon S3 File Gateway User Guide • API version: 2013-06-30 • Latest documentation update: June 06, 2024 The following table describes important changes in each release of this user guide after April 2018. For notification about updates to this documentation, you can subscribe to an RSS feed. Change Description Date Notice of availability change for FSx File Gateway Amazon FSx File Gateway is no longer available to new October 28, 2024 customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post. Notice of availability change for FSx File Gateway AWS Storage Gateway’s FSx File Gateway will no September 26, 2024 longer be available to new customers starting 10/28/24. To use the service, you must sign up prior to that date. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post. Added support for Dual-laye r Server-Side Encryption with You can now use dual-laye r server-side encryptio AWS KMS keys (DSSE-KMS) n with AWS KMS keys to September 13, 2024 API Version 2013-06-30 411 AWS Storage Gateway Amazon S3 File Gateway User Guide encrypt the files that S3 File Gateway uploads to Amazon S3. For more informati on about DSSE-KMS, see Encrypt objects stored by File Gateway in Amazon S3. Added option to turn maintenance updates on or Storage Gateway receives regular maintenance updates June 6, 2024 off that can include operating system and software upgrades, fixes to address stability, performance, and security, and access to new features. You can now configure a setting to turn these updates on or off for each individual gateway in your deployment. For more information, see Managing gateway updates using the AWS Storage Gateway console. Added new SMB security level S3 File Gateway now supports an additional security level May 23, 2024 that you can use to enforce 256-bit AES encryption for SMB client connections. For more information, see Set a security level for your gateway. API Version 2013-06-30 412 AWS Storage Gateway Amazon S3 File Gateway User Guide Gateway appliance software version reporting and release Added release notes to describe the new and updated October 5, 2023 notes for S3 File Gateway features, improvements, Updated recommended CloudWatch alarms and fixes that are included with each version of the Amazon S3 File Gateway appliance. You can determine a gateway's software version number from the Storage Gateway console or by u sing the AWS CLI. For more information, see Release Notes — Gateway Appliance Software. The CloudWatch HealthNot October 2, 2023 alarm now ifications applies to and is recommende d for all gateway types and host platforms. Recommend ed configuration settings have also been updated for HealthNotifications and AvailabilityNotifi cations . For more information see Understan ding CloudWatch alarms. API Version 2013-06-30 413 AWS Storage Gateway Amazon S3 File Gateway User Guide Added GatewayClockOutOfS ync troubleshooting tips The Troubleshooting: File Gateway issues section now October 19, 2022 includes troubleshooting guidelines to help diagnose problems you may encounter if your gateway system clock is not synchronized with the AWS Storage Gateway server time. For more informati on, see Error: GatewayCl ockOutOfSync. Updated gateway creation procedures The procedure for creating a new gateway has been October 12, 2021 updated to reflect changes in the Storage Gateway console. For more informati on, see Create and activate an Amazon S3 File Gateway. Support for force-closing files on SMB file shares You can now use Local Group settings to assign Gateway October 12, 2021 Admin permissions. Gateway Admins can use the Shared Folders Microsoft Managemen t Console snap-in to force- close files that are open and locked on SMB file shares. For more information, see Configure Local Groups for your
|
storagegateway-s3file-ug-155
|
storagegateway-s3file-ug.pdf
| 155 |
on, see Error: GatewayCl ockOutOfSync. Updated gateway creation procedures The procedure for creating a new gateway has been October 12, 2021 updated to reflect changes in the Storage Gateway console. For more informati on, see Create and activate an Amazon S3 File Gateway. Support for force-closing files on SMB file shares You can now use Local Group settings to assign Gateway October 12, 2021 Admin permissions. Gateway Admins can use the Shared Folders Microsoft Managemen t Console snap-in to force- close files that are open and locked on SMB file shares. For more information, see Configure Local Groups for your gateway. API Version 2013-06-30 414 AWS Storage Gateway Amazon S3 File Gateway User Guide Audit log support for NFS file shares You can now configure NFS file shares to generate audit October 12, 2021 Access point alias support VPC endpoint and access point support Opportunistic locking support logs that provide details about user access to files and folders within a file share. You can use these logs to monitor user activities and take action if inappropriate activity patt erns are identified. For more information, see Understandi ng File Gateway audit logs. File Gateway file shares can now connect to Amazon S3 storage using bucket-style access point aliases. For more information, see Create a file share. File Gateway file shares can now connect to S3 buckets through access points or interface endpoints in your VPC powered by AWS PrivateLink. For more information, see Create a file share. File Gateway file shares can now use opportunistic locking to optimize their file buffering strategy, which improves performance in most cases, particularly with regard to Windows context menus. For more information, see Create an SMB file share. October 12, 2021 July 7, 2021 July 7, 2021 API Version 2013-06-30 415 AWS Storage Gateway Amazon S3 File Gateway User Guide FedRAMP compliance November 24, 2020 Storage Gateway is now FedRAMP compliant. For more information, see Compliance validation for Storage Gateway. File upload notification for File Gateway File Gateway now provides file upload notification, November 9, 2020 which notifies you when a fi le has been fully uploaded to Amazon S3 by the File Gateway. For more informati on, see Getting file upload notification. Access-based enumeration for File Gateway File Gateway now provides access-based enumeration, November 9, 2020 File Gateway migration which filters the enumerati on of files and folders on an SMB file share based on the share's ACLs. For more information, see Creating an SMB file share. File Gateway now provides a documented process for replacing an existing File Gateway with a new File Gateway. For more informati on, see Replacing a File Gateway with a new File Gateway. October 30, 2020 API Version 2013-06-30 416 AWS Storage Gateway Amazon S3 File Gateway User Guide File Gateway cold cache read performance 4x increase Storage Gateway has increased cold cache read August 31, 2020 performance 4x. For more information, see Performance guidance for File Gateways. Order the hardware appliance through the console You can now order the hardware appliance through August 12, 2020 the AWS Storage Gateway console. For more informati on, see Using the AWS Storage Gateway Hardware Appliance. Support for Federal Informati on Processing Standard You can now activate a gateway with FIPS endpoints July 31, 2020 (FIPS) endpoints in new AWS in the US East (Ohio), US E Regions ast (N. Virginia), US West (N. California), US West (Oregon), and Canada (Central) Regions. For more informati on, see AWS Storage Gateway endpoints and quotas in the AWS General Reference. API Version 2013-06-30 417 AWS Storage Gateway Amazon S3 File Gateway User Guide Support for multiple file shares attached to a single File Gateway now supports creating multiple file shares July 7, 2020 Amazon S3 bucket for a single S3 bucket and synchronizing the File Gateway's local cache with a bucket based on frequency of directory access. You can limit the number of buckets necessary to manage the file shares that you create on your File Gateway. You can define multiple S3 prefixes for an S3 bucket and map a single S3 prefix to a single gateway file share. You can also define gateway file share names to be independent of the bucket name to fit the on-premises file share naming convention. For more information, see Creating an NFS file share or Creating an SMB file share. Storage Gateway now supports a local cache of up to 64 TB for File Gateway, improving performance for on-premises applications by providing low-latency access to larger working datasets. For more information, see Recommended local disk sizes for your gateway in the Storage Gateway User Guide. July 7, 2020 API Version 2013-06-30 418 File Gateway local cache storage 4x increase AWS Storage Gateway Amazon S3 File Gateway User Guide View Amazon CloudWatc h alarms in the Storage
|
storagegateway-s3file-ug-156
|
storagegateway-s3file-ug.pdf
| 156 |
name to fit the on-premises file share naming convention. For more information, see Creating an NFS file share or Creating an SMB file share. Storage Gateway now supports a local cache of up to 64 TB for File Gateway, improving performance for on-premises applications by providing low-latency access to larger working datasets. For more information, see Recommended local disk sizes for your gateway in the Storage Gateway User Guide. July 7, 2020 API Version 2013-06-30 418 File Gateway local cache storage 4x increase AWS Storage Gateway Amazon S3 File Gateway User Guide View Amazon CloudWatc h alarms in the Storage You can now view CloudWatc h alarms in the Storage May 29, 2020 Gateway console Gateway console. For more information, see Understan ding CloudWatch alarms. Support for Federal Informati on Processing Standard (FIPS) You can now activate a gateway with FIPS endpoints May 22, 2020 endpoints New AWS Regions in the AWS GovCloud (US) Regions. To choose a FIPS endpoint for a File Gateway, see Choosing a service endpoint. Storage Gateway is now available in the Africa (Cape Town) and Europe (Milan) Regions. For more informati on, see AWS Storage Gateway endpoints and quotas in the AWS General Reference. May 7, 2020 API Version 2013-06-30 419 AWS Storage Gateway Amazon S3 File Gateway User Guide Support for S3 Intelligent- Tiering storage class Storage Gateway now supports S3 Intelligent-Tierin April 30, 2020 g storage class. The S3 I ntelligent-Tiering storage class optimizes storage costs by automatically moving data to the most cost-effe ctive storage access tier, without performance impact or operational overhead. For more information, see Storage class for automatic ally optimizing frequently and infrequently accessed objects in the Amazon Simple Storage Service User Guide. Storage Gateway is now available in the AWS GovCloud (US-East) Region. For more information, see AWS Storage Gateway Endp oints and Quotas in the AWS General Reference. March 12, 2020 New AWS Region API Version 2013-06-30 420 AWS Storage Gateway Amazon S3 File Gateway User Guide Support for Linux Kernel-ba sed Virtual Machine (KVM) Storage Gateway now provides the ability to deploy February 4, 2020 hypervisor an on-premises gateway on the KVM virtualization platform. Gateways deployed on KVM have all the same functionality and features as the existing on-premises gateways. For more informat ion, see Supported Hy pervisors and Host Requireme nts in the Storage Gateway User Guide. Support for VMware vSphere High Availability Storage Gateway now provides support for high November 20, 2019 availability on VMware to help protect storage workloads against hardware, hypervisor, or network failures. For more informat ion, see Using VMware vSphere High Availability with Storage Gateway in the Storage Gateway User Guide. This release also includes performance improvements. For more information, see Performance in the Storage Gateway User Guide. API Version 2013-06-30 421 AWS Storage Gateway Amazon S3 File Gateway User Guide Support for Amazon CloudWatch Logs New AWS Region New AWS Region September 4, 2019 August 14, 2019 July 29, 2019 You can now configure File Gateways with Amazon CloudWatch Log Groups to get notified about errors and the health of your gateway and its resources. For more information, see Getting Noti fied About Gateway Health and Errors With Amazon CloudWatch Log Groups in the Storage Gateway User Guide. Storage Gateway is now available in the Asia Pacific (Hong Kong) Region. For more information, see AWS Storage Gateway Endp oints and Quotas in the AWS General Reference. Storage Gateway is now available in the Middle East (Bahrain) Region. For more information, see AWS Storage Gateway Endp oints and Quotas in the AWS General Reference. API Version 2013-06-30 422 AWS Storage Gateway Amazon S3 File Gateway User Guide Support for activating a gateway in a virtual private You can now activate a gateway in a VPC. You can June 20, 2019 cloud (VPC) create a private connection between your on-premises software appliance and cloud- based storage infrastructure . For more information, see Activating a Gateway in a V irtual Private Cloud. SMB file share support for Microsoft Windows ACLs For File Gateways, you can now use Microsoft Windows May 8, 2019 access control lists (ACLs) to control access to Server Message Block (SMB) file shares. For more information, see Using Microsoft Windows ACLs to Control Access to an SMB File Share. File Gateway support for tag- based authorization File Gateway now supports tag-based authorization. You March 4, 2019 can control access to File Gateway resources based on the tags on those resources . You can also control access based on the tags that can be passed in an IAM request condition. For more informati on, see Controlling Access to File Gateway Resources. API Version 2013-06-30 423 AWS Storage Gateway Amazon S3 File Gateway User Guide Availability of AWS Storage Gateway Hardware Appliance The AWS Storage Gateway Hardware Appliance is now February
|
storagegateway-s3file-ug-157
|
storagegateway-s3file-ug.pdf
| 157 |
Windows ACLs to Control Access to an SMB File Share. File Gateway support for tag- based authorization File Gateway now supports tag-based authorization. You March 4, 2019 can control access to File Gateway resources based on the tags on those resources . You can also control access based on the tags that can be passed in an IAM request condition. For more informati on, see Controlling Access to File Gateway Resources. API Version 2013-06-30 423 AWS Storage Gateway Amazon S3 File Gateway User Guide Availability of AWS Storage Gateway Hardware Appliance The AWS Storage Gateway Hardware Appliance is now February 25, 2019 in Europe available in Europe. For more information, see AWS Storage Gateway Hardware Appliance Regions in the AWS General Reference. In addition, you can now increase the useable storage on the AWS Storage Gateway Hardware Appliance from 5 TB to 12 TB and replace the installed copper network card with a 10-gigabi t fiber optic network card. For more information, see Setting Up Your Hardware Appliance. Support for AWS Storage Gateway Hardware Appliance The AWS Storage Gateway Hardware Appliance includes September 18, 2018 Storage Gateway software preinstalled on a third-party server. You can manage the appliance from the AWS Management Console. The appliance can host file, tape, and Volume Gateways. For more information, see Using the Storage Gateway Hard ware Appliance. File Gateways added support for the Server Message Block (SMB) protocol to file shares. For more information, see Creating a File Share. Support for Server Message Block (SMB) protocol June 20, 2018 API Version 2013-06-30 424 AWS Storage Gateway Earlier updates Amazon S3 File Gateway User Guide The following table describes important changes in each release of the AWS Storage Gateway User Date Changed April 4, 2018 April 3, 2018 March 1, 2018 Guide before May 2018. Change Description Support for S3 One Zone-IA For File Gateways, you can now choose S3 One Zone- IA as the default storage class for your file shares. storage class Using this storage class, you can store your object data in a single Availability Zone in Amazon S3. For more information, see Creating a file share. New AWS Region Tape Gateway is now available in the Asia Pacific (Singapore) Region. For detailed information, see AWS Regions that support Storage Gateway. Support for refresh cache notification, With File Gateways, you can now be notified when the gateway finishes refreshing the cache for your Amazon S3 bucket. For more information, see Requester Pays, RefreshCache.html in the Storage Gateway API Refer and canned ACL ence. s for Amazon S3 buckets For File Gateways, you can now specify that the requester or reader pays for access charges instead of the bucket owner. File Gateway can now give full control of written files to the owner of the S3 bucket that maps to the NFS file share. For more information, see Creating a file share. New AWS Region Storage Gateway is now available in the Europe (Paris) Region. For detailed information, see AWS Regions that support Storage Gateway. December 18, 2017 Support for file upload notificat File Gateway can now send notifications when all files written to your NFS file share have been November 21, 2017 Earlier updates API Version 2013-06-30 425 AWS Storage Gateway Amazon S3 File Gateway User Guide Change Description Date Changed ion and guessing uploaded to Amazon S3. For more information, see of the Multip urpose Internet Mail Extension (MIME) type NotifyWhenUploaded in the Storage Gateway API Reference. File Gateway can now guess the MIME type for uploaded objects based on file extensions. For more information, see Creating a file share. Support for VMware ESXi AWS Storage Gateway now supports VMware ESXi Hypervisor version 6.5. This is in addition to version September 13, 2017 Hypervisor version 4.1, 5.0, 5.1, 5.5, and 6.0. For more information, see 6.5 Supported hypervisors and host requirements. File Gateway support for You can now deploy a File Gateway on a Microsoft Hyper-V hypervisor. For information, see Supported June 22, 2017 Microsoft Hyper-V hypervisors and host requirements. hypervisor New AWS Region Storage Gateway is now available in the Asia Pacific (Mumbai) Region. For detailed information, see AWS May 02, 2017 Regions that support Storage Gateway. Updates to file share settings File Gateways now add mount options to the file share settings. You can now set squash and read- March 28, 2017 Support for cache refresh for file shares only options for your file share. For more informati on, see Creating a file share. File Gateways now can find objects in the Amazon S3 bucket that were added or removed since the gateway last listed the bucket's contents and cached the results. For more information, see RefreshCache in the API Reference. Earlier updates API Version 2013-06-30 426 AWS Storage Gateway Amazon S3 File Gateway User Guide Change Description Support
|
storagegateway-s3file-ug-158
|
storagegateway-s3file-ug.pdf
| 158 |
share settings File Gateways now add mount options to the file share settings. You can now set squash and read- March 28, 2017 Support for cache refresh for file shares only options for your file share. For more informati on, see Creating a file share. File Gateways now can find objects in the Amazon S3 bucket that were added or removed since the gateway last listed the bucket's contents and cached the results. For more information, see RefreshCache in the API Reference. Earlier updates API Version 2013-06-30 426 AWS Storage Gateway Amazon S3 File Gateway User Guide Change Description Support for File Gateways on AWS Storage Gateway now provides the ability to deploy a File Gateway in Amazon EC2. You can Amazon EC2 launch a File Gateway in Amazon EC2 using the Date Changed February 08, 2017 Storage Gateway Amazon Machine Image (AMI) now available as a community AMI. For information about how to create a File Gateway and deploy it on an EC2 instance, see Create and activate an Amazon S3 File Gateway. For information about how to launch a File Gateway AMI, see Deploy a default Amazon EC2 host for S3 File Gateway. In addition, File Gateway now supports HTTP proxy configuration. For more information, see Routing your gateway deployed on Amazon EC2 through an HTTP proxy. New AWS Region Storage Gateway is now available in the Europe (London) Region. For detailed information, see AWS December 13, 2016 Regions that support Storage Gateway. New AWS Region Storage Gateway is now available in the Canada (Central) Region. For detailed information, see AWS December 08, 2016 Support for File Gateway Regions that support Storage Gateway. In addition to Volume Gateways and Tape Gateway, Storage Gateway now provides File Gateway. File Gateway combines a service and virtual software appliance, allowing you to store and retrieve objects in Amazon S3 using industry-standard file protocols such as Network File System (NFS). The gateway provides access to objects in Amazon S3 as files on an NFS mount point. November 29, 2016 Earlier updates API Version 2013-06-30 427 AWS Storage Gateway Amazon S3 File Gateway User Guide Release notes for gateway appliance software These release notes describe the new and updated features, improvements, and fixes that are included with each version of the Amazon S3 File Gateway appliance. Each software version is identified by its release date and a unique version number. You can determine a gateway's software version number by checking its Details page in the Storage Gateway console, or by calling the DescribeGatewayInformation API action using an AWS CLI command similar to the following: aws storagegateway describe-gateway-information --gateway-arn "arn:aws:storagegateway:us-west-2:123456789012:gateway/sgw-12A3456B" The version number is returned in the SoftwareVersion field of the API response. Note A gateway won't report software version information under the following circumstances: • The gateway is offline. • The gateway is running older software that doesn't support version reporting. • The gateway type isn't S3 File Gateway. For more information about S3 File Gateway updates, including how to modify the default automatic maintenance and update schedule for a gateway, see Managing Gateway Updates Using the AWS Storage Gateway Console. Release Date Software Version Release Notes 2025-04-28 1.27.5 Maintenance Updates: • Fixed issues related to the upload rename order log. • Added debug tooling to help determine the causes of upload issues. API Version 2013-06-30 428 AWS Storage Gateway Amazon S3 File Gateway User Guide Release Date Software Version Release Notes • Added system statistics and metrics for deeper insight of gateway performance. • Updated operating system and software elements to improve security and performance. 2025-04-14 1.27.4 Maintenance Updates: • Updated operating system and software elements to improve security and performance. 2025-04-01 1.27.3 Maintenance Updates: • Update for gateway logging configuration. No customer action required. API Version 2013-06-30 429 AWS Storage Gateway Amazon S3 File Gateway User Guide Release Date Software Version Release Notes 2025-03-17 1.27.2 Maintenance Updates: • Added an API action that removes cached file share data and metadata for files that have failed to upload from your gateway to Amazon S3. Your AWS account must be allowlist ed to use this function. If your gateway has problems with files failing upload, AWS Support can unlock the function and provide guidance about its use. • Added capability for new gateways to log the order of object rename upload operations. This helps prevent files from failing to upload to Amazon S3 after repeated or overlapping rename operations. • Fixed an issue related to SMB unintentionally opening ports. • Updated operating system and software elements to improve security and performance. API Version 2013-06-30 430 AWS Storage Gateway Amazon S3 File Gateway User Guide Release Date Software Version Release Notes 2025-02-17 1.27.1 Maintenance Updates: • Removed Java 11. • Added cache function for Support use. • Updated operating system and software elements to
|
storagegateway-s3file-ug-159
|
storagegateway-s3file-ug.pdf
| 159 |
guidance about its use. • Added capability for new gateways to log the order of object rename upload operations. This helps prevent files from failing to upload to Amazon S3 after repeated or overlapping rename operations. • Fixed an issue related to SMB unintentionally opening ports. • Updated operating system and software elements to improve security and performance. API Version 2013-06-30 430 AWS Storage Gateway Amazon S3 File Gateway User Guide Release Date Software Version Release Notes 2025-02-17 1.27.1 Maintenance Updates: • Removed Java 11. • Added cache function for Support use. • Updated operating system and software elements to improve security and performance. 2025-01-17 1.27.0 Features: • Cache Reports (coming soon) - Updated gateway software to support launch of an upcoming feature designed to generate reports of the file metadata currently cached by an S3 File Gateway. You will be able to use these reports to troubleshoot issues if you have files failing upload from your gateway to Amazon S3. Maintenance Updates: • Updated operating system and software elements to improve security and performance. API Version 2013-06-30 431 AWS Storage Gateway Amazon S3 File Gateway User Guide Release Date Software Version Release Notes 2025-01-09 1.26.9 Maintenance Updates: • Updated operating system and software elements to improve security and performance. 2024-12-18 1.26.8 Maintenance Updates: • Updated operating system and software elements to improve security and performance. 2024-11-18 1.26.7 Maintenance Updates: • Updated operating system and software elements to improve security and performance. 2024-10-17 1.26.6 Maintenance Updates: • Updated operating system and software elements to improve security and performance. 2024-09-30 1.26.5 Maintenance Updates: • Fixed an issue with on- premises gateways not allowing support channels • Updated operating system and software elements to improve security and performance. API Version 2013-06-30 432 AWS Storage Gateway Amazon S3 File Gateway User Guide Release Date Software Version Release Notes 2024-09-16 1.26.3 Maintenance Updates: • Updated operating system and software elements to improve security and performance. 2024-08-21 1.26.1 Maintenance Updates: • Fixed an issue related to logging. 2024-08-19 1.26.0 Maintenance Updates: • Updated operating system and software elements to improve security and performance. 2024-07-16 1.25.2 Maintenance Updates: • Updated operating system and software elements to improve security and performance. 2024-06-17 1.25.1 Maintenance Updates: • Fixed an issue with upgrades when using a proxy and DNS is disabled. • Updated operating system and software elements to improve security and performance. API Version 2013-06-30 433 AWS Storage Gateway Amazon S3 File Gateway User Guide Release Date Software Version Release Notes 2024-05-15 1.25.0 Features: • Added ability to set AES-128 or AES-256 encryption minimum. This is a gateway change only and will be available in the Storage Gateway console in an upcoming release. • Increased rotation of system logs when disk space is low. Previously, log writing that filled the root disk would cause the gateway to stop. Now, as space decreases, the gateway will make more room for newer logs by eliminating older logs. • Added S3 path in health notifications for file upload errors. Previously, health notifications only showed the path to the file on the gateway. Notifications now show the path to help users locate the file in S3. • Service now ignores backend blockers during forced file share deletes. Previously, forced deletes would stop without explanation when encountering blockers. API Version 2013-06-30 434 AWS Storage Gateway Amazon S3 File Gateway User Guide Release Date Software Version Release Notes Forced deletes now continue uninterrupted in these scenarios. Maintenance Updates: • Updated the NFS stack. • Upgraded Java 17 JRE. • Updated operating system and software elements to improve security and performance. 2024-04-15 1.24.5 Maintenance Updates: • Updated operating system and software elements to improve security and performance. 2024-04-01 1.24.4 Maintenance Updates: • Addressed missing Network Time Protocol (NTP) component. API Version 2013-06-30 435 AWS Storage Gateway Amazon S3 File Gateway User Guide Release Date Software Version Release Notes 2024-03-18 1.24.3 Maintenance Updates: • Fixed an issue related to case-sensitive lookup performance. • Fixed an issue that caused processes to crash. • Updated operating system and software elements to improve security and performance. 2024-01-12 1.24.2 Maintenance Updates: • Addressed SMB logging issue. 2023-12-27 1.24.1 Maintenance Updates: • Addressed SMB stability issue. API Version 2013-06-30 436 AWS Storage Gateway Amazon S3 File Gateway User Guide Release Date Software Version Release Notes 2023-12-01 1.24.0 Features: • Updated SMB stack. • Added support for AES-256 encryption, plus more secure variants of AES-128 encryption and signing when using an SMB 3.1.1 client which requests it. • SMBv1 (LANMAN/CIFS) server-side copy and server-side wildcard expansion functiona lity have been removed. (SMBv2 and SMBv3 are unaffected.) This may negatively impact performance of certain SMBv1 workloads. If you use SMBv1, you are encouraged to migrate to SMBv2 or SMBv3. Maintenance Updates: • Updated operating system and software elements to improve security and performance.
|
storagegateway-s3file-ug-160
|
storagegateway-s3file-ug.pdf
| 160 |
Storage Gateway Amazon S3 File Gateway User Guide Release Date Software Version Release Notes 2023-12-01 1.24.0 Features: • Updated SMB stack. • Added support for AES-256 encryption, plus more secure variants of AES-128 encryption and signing when using an SMB 3.1.1 client which requests it. • SMBv1 (LANMAN/CIFS) server-side copy and server-side wildcard expansion functiona lity have been removed. (SMBv2 and SMBv3 are unaffected.) This may negatively impact performance of certain SMBv1 workloads. If you use SMBv1, you are encouraged to migrate to SMBv2 or SMBv3. Maintenance Updates: • Updated operating system and software elements to improve security and performance. API Version 2013-06-30 437 AWS Storage Gateway Amazon S3 File Gateway User Guide Release Date Software Version Release Notes 2023-10-24 1.23.2 Maintenance Updates: 2023-08-14 1.23.1 Maintenance Updates: • Fixed an issue related to Support Channel not connecting properly for certain users. 2023-06-12 1.23.0 • Updated NTP server to use sync server for new gateways. Features: • Increased upload threads for some AWS accounts. Maintenance Updates: • Fixed an access violation issue on large copies. • Fixed an NFS issue. • Removed Java 8. • Updated operating system and software elements to improve security and performance. 2023-04-19 1.22.1 Maintenance Updates: • Fixed an issue related to renaming folders and files. API Version 2013-06-30 438 AWS Storage Gateway Amazon S3 File Gateway User Guide Release Date Software Version Release Notes 2023-01-18 1.22.0 Features: • Added support for DOS attributes. • Increased the number of supported file shares per gateway from 10 to 50. • Implemented a clock skew detection mechanism to determine when a gateway and a service are out of sync. Maintenance Updates: • Updated SMB stack. 2022-07-06 1.21.2 Maintenance Updates: • Updated operating system and software elements to improve security and performance. 2022-02-16 1.21.1 Features: • Added new metrics for rename and deletion in cache. Maintenance Updates: • Fixed miscellaneous issues. API Version 2013-06-30 439 AWS Storage Gateway Amazon S3 File Gateway User Guide Release Date Software Version Release Notes 2022-01-18 1.21.0 Features: • Added new CloudWatch metrics. • Added bandwidth throttlin g for data uploads. 2021-12-12 1.20.0 URGENT UPDATE: • Addressed Log4j vulnerabi lity. API Version 2013-06-30 440
|
storagegateway-tgw-ug-001
|
storagegateway-tgw-ug.pdf
| 1 |
Tape Gateway User Guide AWS Storage Gateway API Version 2013-06-30 Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS Storage Gateway Tape Gateway User Guide AWS Storage Gateway: Tape Gateway User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS Storage Gateway Table of Contents Tape Gateway User Guide What is Tape Gateway? ................................................................................................................... 1 How Tape Gateway works .......................................................................................................................... 1 Tape Gateways ......................................................................................................................................... 2 Getting started with AWS Storage Gateway .................................................................................. 5 Sign Up for AWS Storage Gateway .......................................................................................................... 5 Create an IAM user with administrator privileges ................................................................................. 6 Accessing AWS Storage Gateway .............................................................................................................. 7 AWS Regions that support Storage Gateway ......................................................................................... 8 Tape Gateway setup requirements ................................................................................................. 9 Hardware and storage requirements ........................................................................................................ 9 Hardware requirements for VMs .......................................................................................................... 9 Requirements for Amazon EC2 instance types ............................................................................... 10 .................................................................................................................................................................. 10 Storage requirements .......................................................................................................................... 10 Network and firewall requirements ....................................................................................................... 11 Port requirements ................................................................................................................................. 12 Networking and firewall requirements for the hardware appliance ........................................... 23 Allowing gateway access through firewall and routers ................................................................ 25 Configuring security group ................................................................................................................. 27 Supported hypervisors and host requirements ................................................................................... 28 Supported iSCSI initiators ........................................................................................................................ 29 Supported third-party backup applications ......................................................................................... 29 Using the hardware appliance ...................................................................................................... 32 Setting up your hardware appliance ...................................................................................................... 33 Physically installing your hardware appliance ..................................................................................... 34 Accessing the hardware appliance console ........................................................................................... 36 Configuring hardware appliance network parameters ....................................................................... 38 Activating your hardware appliance ....................................................................................................... 39 Creating a gateway on your hardware appliance ................................................................................ 41 Configuring a gateway IP address on the hardware appliance ......................................................... 42 Removing gateway software from your hardware appliance ........................................................... 44 Deleting your hardware appliance ......................................................................................................... 45 Creating your gateway .................................................................................................................. 47 Overview - Gateway Activation ............................................................................................................... 47 API Version 2013-06-30 iii AWS Storage Gateway Tape Gateway User Guide Set up gateway ..................................................................................................................................... 47 Connect to AWS .................................................................................................................................... 47 Review and activate ............................................................................................................................. 48 Overview - Gateway Configuration ........................................................................................................ 48 Overview - Storage Resources ................................................................................................................ 48 Create and activate a Tape Gateway ..................................................................................................... 48 Set up a Tape Gateway ....................................................................................................................... 49 Connect your Tape Gateway to AWS ................................................................................................ 50 Review settings and activate your Tape Gateway .......................................................................... 51 Configure your Tape Gateway ............................................................................................................ 52 Creating Tapes ............................................................................................................................................ 54 WORM Tape Protection ....................................................................................................................... 55 Creating Tapes Manually ..................................................................................................................... 55 Allowing Automatic Tape Creation ................................................................................................... 57 Creating Custom Tape Pools ................................................................................................................... 60 Choosing a Type .................................................................................................................................... 60 Tape Retention Lock ............................................................................................................................ 61 Creating a Custom Tape Pool ............................................................................................................ 62 Connecting Your VTL Devices .................................................................................................................. 63 Connecting to a Microsoft Windows Client ..................................................................................... 63 Connecting to a Linux Client .............................................................................................................. 64 Testing Your Gateway ............................................................................................................................... 68 Arcserve Backup .................................................................................................................................... 69 Bacula Enterprise .................................................................................................................................. 72 Commvault ............................................................................................................................................. 76 Dell EMC NetWorker ............................................................................................................................. 81 IBM Data Protect ................................................................................................................................... 85 OpenText Data Protector .................................................................................................................... 88 Microsoft System Center DPM ........................................................................................................... 95 NovaStor DataCenter/Network ........................................................................................................ 100 Quest NetVault Backup ..................................................................................................................... 105 Veeam Backup & Replication ........................................................................................................... 108 Veritas Backup Exec ........................................................................................................................... 111 Veritas NetBackup .............................................................................................................................. 115 Where do I go from here? ..................................................................................................................... 122 Activating your gateway in a virtual private cloud ........................................................................... 122 API Version 2013-06-30 iv AWS Storage Gateway Tape Gateway User Guide Creating a VPC endpoint for Storage Gateway ............................................................................ 123 Managing your Tape Gateway .................................................................................................... 125 Editing Gateway Information ................................................................................................................ 126 Managing Automatic Tape Creation .................................................................................................... 127 Archiving Tapes ........................................................................................................................................ 129 Moving tapes to S3 Glacier Deep Archive .......................................................................................... 129 Retrieving Archived Tapes ...................................................................................................................... 130 Viewing tape usage statistics ................................................................................................................ 132 Deleting Tapes .......................................................................................................................................... 132 Deleting Custom Tape Pools ................................................................................................................. 134 Deactivating Your Tape Gateway .......................................................................................................... 134 Understanding Tape Status ................................................................................................................... 135 Understanding Tape Status Information in a VTL ....................................................................... 135 Determining Tape Status in an Archive ......................................................................................... 137 Moving your data to a new gateway ................................................................................................... 138 Moving virtual tapes to a new Tape Gateway .............................................................................. 138 Monitoring Storage Gateway ...................................................................................................... 143 Understanding gateway metrics ........................................................................................................... 143 Dimensions for Storage Gateway metrics ..................................................................................... 147 Monitoring the upload buffer ............................................................................................................... 147 Monitoring cache storage ...................................................................................................................... 150 Understanding CloudWatch alarms ..................................................................................................... 151 Creating recommended CloudWatch alarms ...................................................................................... 153 Creating a custom CloudWatch alarm ................................................................................................. 154 Monitoring Your Tape Gateway ............................................................................................................ 156 Getting Tape Gateway Health Logs ................................................................................................ 156 Using Amazon CloudWatch Metrics ................................................................................................ 158 Understanding virtual tape metrics ................................................................................................ 159 Measuring Performance Between Your Tape Gateway and AWS .............................................. 162 Maintaining Your Gateway .......................................................................................................... 165 Managing local disks ............................................................................................................................... 165 Deciding the amount of local disk storage ................................................................................... 166 Add upload buffer or cache storage .............................................................................................. 169 Managing Bandwidth
|
storagegateway-tgw-ug-002
|
storagegateway-tgw-ug.pdf
| 2 |
Dimensions for Storage Gateway metrics ..................................................................................... 147 Monitoring the upload buffer ............................................................................................................... 147 Monitoring cache storage ...................................................................................................................... 150 Understanding CloudWatch alarms ..................................................................................................... 151 Creating recommended CloudWatch alarms ...................................................................................... 153 Creating a custom CloudWatch alarm ................................................................................................. 154 Monitoring Your Tape Gateway ............................................................................................................ 156 Getting Tape Gateway Health Logs ................................................................................................ 156 Using Amazon CloudWatch Metrics ................................................................................................ 158 Understanding virtual tape metrics ................................................................................................ 159 Measuring Performance Between Your Tape Gateway and AWS .............................................. 162 Maintaining Your Gateway .......................................................................................................... 165 Managing local disks ............................................................................................................................... 165 Deciding the amount of local disk storage ................................................................................... 166 Add upload buffer or cache storage .............................................................................................. 169 Managing Bandwidth .............................................................................................................................. 170 Changing Bandwidth Throttling Using the Storage Gateway Console .................................... 171 Scheduling Bandwidth Throttling ................................................................................................... 171 API Version 2013-06-30 v AWS Storage Gateway Tape Gateway User Guide Using the AWS SDK for Java ........................................................................................................... 173 Using the AWS SDK for .NET ........................................................................................................... 175 Using the AWS Tools for Windows PowerShell ............................................................................ 177 Managing gateway updates ................................................................................................................... 178 Update frequency and expected behavior .................................................................................... 178 Turn maintenance updates on or off ............................................................................................. 179 Modify the gateway maintenance window schedule .................................................................. 180 Apply an update manually ............................................................................................................... 181 Shutting Down Your Gateway VM ........................................................................................................ 182 Starting and Stopping a Tape Gateway ......................................................................................... 183 Deleting your gateway and removing resources ............................................................................... 184 Deleting Your Gateway by Using the Storage Gateway Console .............................................. 184 Removing Resources from a Gateway Deployed On-Premises .................................................. 186 Removing Resources from a Gateway Deployed on an Amazon EC2 Instance ....................... 187 Performing maintenance tasks using the local console ............................................................ 189 Accessing the Gateway Local Console ................................................................................................. 189 Accessing the Gateway Local Console with Linux KVM .............................................................. 190 Accessing the Gateway Local Console with VMware ESXi .......................................................... 190 Access the Gateway Local Console with Microsoft Hyper-V ...................................................... 191 Performing Tasks on the VM Local Console ...................................................................................... 192 Logging in to the Tape Gateway local console ............................................................................ 193 Configuring a SOCKS5 proxy for your on-premises gateway .................................................... 195 Configuring Your Gateway Network ............................................................................................... 196 Testing your gateway connectivity to the internet ..................................................................... 201 Running storage gateway commands in the local console for an on-premises gateway ..... 202 Viewing your gateway system resource status ............................................................................. 204 Performing Tasks on the EC2 Local Console ..................................................................................... 205 Logging In to Your EC2 Gateway Local Console .......................................................................... 206 Configuring an HTTP proxy .............................................................................................................. 207 Testing gateway network connectivity .......................................................................................... 208 Viewing your gateway system resource status ............................................................................. 209 Running Storage Gateway commands on the local console ..................................................... 210 Performance and optimization for Tape Gateway .................................................................... 212 Performance guidance for Tape Gateways ......................................................................................... 212 Optimizing gateway performance ........................................................................................................ 215 Recommended Configuration .......................................................................................................... 215 API Version 2013-06-30 vi AWS Storage Gateway Tape Gateway User Guide Add Resources to Your Gateway ..................................................................................................... 216 Optimize iSCSI Settings .................................................................................................................... 219 Use a Larger Block Size for Tape Drives ........................................................................................ 219 Optimize the Performance of Virtual Tape Drives ...................................................................... 219 Add Resources to Your Application Environment ........................................................................ 220 Security ........................................................................................................................................ 221 Data protection ........................................................................................................................................ 222 Data encryption .................................................................................................................................. 223 Identity and Access Management ........................................................................................................ 224 Audience ............................................................................................................................................... 225 Authenticating with identities ......................................................................................................... 225 Managing access using policies ....................................................................................................... 228 How AWS Storage Gateway works with IAM ................................................................................ 231 Identity-based policy examples ....................................................................................................... 237 Troubleshooting .................................................................................................................................. 240 Compliance validation ............................................................................................................................ 242 Resilience ................................................................................................................................................... 243 Infrastructure Security ............................................................................................................................ 244 AWS Security Best Practices .................................................................................................................. 245 Logging and Monitoring ......................................................................................................................... 245 Storage Gateway Information in CloudTrail ................................................................................. 245 Understanding Storage Gateway Log File Entries ....................................................................... 246 Troubleshooting gateway issues ................................................................................................. 249 Troubleshooting: gateway offline issues ............................................................................................. 249 Check the associated firewall or proxy .......................................................................................... 250 Check for an ongoing SSL or deep-packet inspection of your gateway's traffic .................... 250 Check for a power outage or hardware failure on the hypervisor host ................................... 250 Check for issues with an associated cache disk ........................................................................... 250 Troubleshooting: gateway activation issues ....................................................................................... 251 Resolve errors when activating your gateway using a public endpoint ................................... 252 Resolve errors when activating your gateway using an Amazon VPC endpoint .................... 255 Resolve errors when activating your gateway using a public endpoint and there is a Storage Gateway VPC endpoint in the same VPC ....................................................................... 259 Troubleshooting on-premises gateway issues ................................................................................... 259 Activating Support to help troubleshoot your gateway ............................................................. 264 Troubleshooting Microsoft Hyper-V setup issues ............................................................................. 265 API Version 2013-06-30 vii AWS Storage Gateway Tape Gateway User Guide Troubleshooting Amazon EC2 gateway issues ................................................................................... 269 Gateway activation hasn't occurred after a few moments ........................................................ 269 Can't find the EC2 gateway instance in the instance list ........................................................... 270 Can't attach a an Amazon EBS volume to the EC2 gateway instance ..................................... 270 No disks available when you try to add storage volumes message ......................................... 270 How to remove a disk allocated as upload buffer space to reduce upload buffer space ...... 271 Throughput to or from the EC2 gateway drops to zero ............................................................. 271 Activating Support to help troubleshoot the gateway
|
storagegateway-tgw-ug-003
|
storagegateway-tgw-ug.pdf
| 3 |
vii AWS Storage Gateway Tape Gateway User Guide Troubleshooting Amazon EC2 gateway issues ................................................................................... 269 Gateway activation hasn't occurred after a few moments ........................................................ 269 Can't find the EC2 gateway instance in the instance list ........................................................... 270 Can't attach a an Amazon EBS volume to the EC2 gateway instance ..................................... 270 No disks available when you try to add storage volumes message ......................................... 270 How to remove a disk allocated as upload buffer space to reduce upload buffer space ...... 271 Throughput to or from the EC2 gateway drops to zero ............................................................. 271 Activating Support to help troubleshoot the gateway ............................................................... 271 Connect to your Amazon EC2 gateway using the serial console .............................................. 273 Troubleshooting hardware appliance issues ...................................................................................... 273 How to determine service IP address ............................................................................................. 273 How to perform a factory reset ...................................................................................................... 274 How to perform a remote restart ................................................................................................... 274 How to obtain Dell iDRAC support ................................................................................................. 274 How to find the hardware appliance serial number ................................................................... 274 How to get hardware appliance support ....................................................................................... 275 Troubleshooting virtual tape issues ..................................................................................................... 275 Recovering a Virtual Tape From An Unrecoverable Gateway .................................................... 275 Troubleshooting Irrecoverable Tapes ............................................................................................. 279 High Availability Health Notifications ............................................................................................ 280 Troubleshooting high availability issues ............................................................................................. 280 Health notifications ............................................................................................................................ 281 Metrics ................................................................................................................................................... 282 Best practices ............................................................................................................................... 283 Best practices: recovering your data .................................................................................................... 283 Recovering from an unexpected VM shutdown ........................................................................... 284 Recovering data from malfunctioning gateway or VM ............................................................... 284 Recovering data from an irrecoverable tape ................................................................................ 285 Recovering data from a malfunctioning cache disk .................................................................... 285 Recovering data from an inaccessible data center ...................................................................... 285 Cleaning up unecessary resources ........................................................................................................ 286 Additional Resources ................................................................................................................... 287 Host setup ................................................................................................................................................. 287 Deploy a default Amazon EC2 host for Tape Gateway ............................................................... 288 Deploy a customized Amazon EC2 instance for Tape Gateway ................................................ 291 Modify Amazon EC2 instance metadata options ......................................................................... 294 API Version 2013-06-30 viii AWS Storage Gateway Tape Gateway User Guide Synchronize VM time with Hyper-V or Linux KVM host time .................................................... 295 Synchronize VM time with VMware host time ............................................................................. 296 Configure paravirtualized disk controllers .................................................................................... 297 Configuring network adapters for your gateway ......................................................................... 298 Using VMware High Availability with Storage Gateway ............................................................. 303 Working with Tape Gateway storage resources ................................................................................ 308 Removing Disks from Your Gateway .............................................................................................. 308 EBS Volumes for EC2 Gateways ...................................................................................................... 310 Working with VTL Devices ................................................................................................................ 311 Working with Tapes ........................................................................................................................... 314 Getting Activation Key ............................................................................................................................ 316 Linux (curl) ........................................................................................................................................... 317 Linux (bash/zsh) .................................................................................................................................. 318 Microsoft Windows PowerShell ....................................................................................................... 319 Using your local console ................................................................................................................... 319 Connecting iSCSI Initiators .................................................................................................................... 320 Connecting VTL devices to a Windows client ............................................................................... 321 Connecting VTL devices to a Linux client ..................................................................................... 324 Customizing iSCSI Settings .............................................................................................................. 325 Configuring CHAP Authentication .................................................................................................. 330 Using AWS Direct Connect with Storage Gateway ........................................................................... 336 Getting the gateway IP address ........................................................................................................... 337 Getting an IP Address from an Amazon EC2 Host ...................................................................... 337 Understanding Resources and Resource IDs ...................................................................................... 338 Working with Resource IDs ............................................................................................................... 339 Tagging Your Resources ......................................................................................................................... 340 Working with Tags ............................................................................................................................. 340 Open-Source Components ..................................................................................................................... 342 Storage Gateway quotas ........................................................................................................................ 342 Quotas for tapes ................................................................................................................................. 342 Recommended local disk sizes for your gateway ........................................................................ 343 API Reference ............................................................................................................................... 344 Required Request Headers ..................................................................................................................... 344 Signing Requests ...................................................................................................................................... 347 Example Signature Calculation ........................................................................................................ 347 Error Responses ........................................................................................................................................ 349 API Version 2013-06-30 ix AWS Storage Gateway Tape Gateway User Guide Exceptions ............................................................................................................................................ 350 Operation Error Codes ....................................................................................................................... 352 Error Responses .................................................................................................................................. 371 Operations ................................................................................................................................................. 373 Document history ........................................................................................................................ 374 Earlier updates .......................................................................................................................................... 390 Release notes ............................................................................................................................... 409 API Version 2013-06-30 x AWS Storage Gateway Tape Gateway User Guide What is Tape Gateway? AWS Storage Gateway connects an on-premises software appliance with cloud-based storage to provide seamless integration with data security features between your on-premises IT environment and the AWS storage infrastructure. You can use the service to store data in the Amazon Web Services Cloud for scalable and cost-effective storage that helps maintain data security. You can deploy Storage Gateway either on-premises as a VM appliance running on VMware ESXi, KVM, or Microsoft Hyper-V hypervisor, as a hardware appliance, or in AWS as an Amazon EC2 instance. You can use gateways hosted on EC2 instances for disaster recovery, data mirroring, and providing storage for applications hosted on Amazon EC2. To see the wide range of use cases that AWS Storage Gateway helps make possible, see AWS Storage Gateway. For current information about pricing, see Pricing on the AWS Storage Gateway details page. AWS Storage Gateway offers file-based (S3 File Gateway and FSx File Gateway), volume-based (Volume Gateway), and tape-based (Tape Gateway) storage solutions. This User Guide provides information related to Tape Gateway. Tape Gateway provides cloud-backed virtual tape storage. With Tape Gateway, you can cost- effectively and durably archive backup data in S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive.
|
storagegateway-tgw-ug-004
|
storagegateway-tgw-ug.pdf
| 4 |
providing storage for applications hosted on Amazon EC2. To see the wide range of use cases that AWS Storage Gateway helps make possible, see AWS Storage Gateway. For current information about pricing, see Pricing on the AWS Storage Gateway details page. AWS Storage Gateway offers file-based (S3 File Gateway and FSx File Gateway), volume-based (Volume Gateway), and tape-based (Tape Gateway) storage solutions. This User Guide provides information related to Tape Gateway. Tape Gateway provides cloud-backed virtual tape storage. With Tape Gateway, you can cost- effectively and durably archive backup data in S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive. Tape Gateway provides a virtual tape infrastructure that scales seamlessly with your business needs and eliminates the operational burden of provisioning, scaling, and maintaining a physical tape infrastructure. For an architectural overview, see How Tape Gateway works. In this User Guide, you can find a Getting Started section that covers setup information common to all gateway types. You can also find Tape Gateway setup requirements, and sections that describe how to deploy, activate, configure, and manage your Tape Gateway. The procedures in this User Guide primarily focus on performing gateway operations by using the AWS Management Console. If you want to perform these operations programmatically, see the AWS Storage Gateway API Reference. How Tape Gateway works Following, you can find an architectural overview of the Tape Gateway solution. How Tape Gateway works API Version 2013-06-30 1 AWS Storage Gateway Tape Gateways Tape Gateway User Guide Tape Gateway offers a durable, cost-effective solution to archive your data in the Amazon Web Services Cloud. With its virtual tape library (VTL) interface, you use your existing tape-based backup infrastructure to store data on virtual tape cartridges that you create on your Tape Gateway. Each Tape Gateway is preconfigured with a media changer and tape drives. These are available to your existing client backup applications as iSCSI devices. You add tape cartridges as you need to archive your data. The following diagram provides an overview of Tape Gateway deployment. The diagram identifies the following Tape Gateway components: • Virtual tape – A virtual tape is like a physical tape cartridge. However, virtual tape data is stored in the Amazon Web Services Cloud. Like physical tapes, virtual tapes can be blank or can have data written on them. You can create virtual tapes either by using the Storage Gateway console or programmatically by using the Storage Gateway API. Each gateway can contain up to 1,500 tapes or up to 1 PiB of total tape data at a time. The size of each virtual tape, which you can configure when you create the tape, is between 100 GiB and 15 TiB. Tape Gateways API Version 2013-06-30 2 AWS Storage Gateway Tape Gateway User Guide • Virtual tape library (VTL) – A VTL is like a physical tape library available on-premises with robotic arms and tape drives. Your VTL includes the collection of stored virtual tapes. Each Tape Gateway comes with one VTL. The virtual tapes that you create appear in your gateway's VTL. Tapes in the VTL are backed up by Amazon S3. As your backup software writes data to the gateway, the gateway stores data locally and then asynchronously uploads it to virtual tapes in your VTL—that is, Amazon S3. • Tape drive – A VTL tape drive is analogous to a physical tape drive that can perform I/O and seek operations on a tape. Each VTL comes with a set of 10 tape drives, which are available to your backup application as iSCSI devices. • Media changer – A VTL media changer is analogous to a robot that moves tapes around in a physical tape library's storage slots and tape drives. Each VTL comes with one media changer, which is available to your backup application as an iSCSI device. • Archive – Archive is analogous to an offsite tape holding facility. You can archive tapes from your gateway's VTL to the archive. If needed, you can retrieve tapes from the archive back to your gateway's VTL. • Archiving tapes – When your backup software ejects a tape, your gateway moves the tape to the archive for long-term storage. The archive is located in the AWS Region in which you activated the gateway. Tapes in the archive are stored in the virtual tape shelf (VTS). The VTS is backed by S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive, low-cost storage service for data archiving, backup, and long-term data retention. • Retrieving tapes – You can't read archived tapes directly. To read an archived tape, you must first retrieve it to your Tape Gateway by using either the Storage Gateway console or the Storage Gateway API. Important If you archive a tape in S3 Glacier Flexible Retrieval, you can retrieve the tape typically within 3-5
|
storagegateway-tgw-ug-005
|
storagegateway-tgw-ug.pdf
| 5 |
AWS Region in which you activated the gateway. Tapes in the archive are stored in the virtual tape shelf (VTS). The VTS is backed by S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive, low-cost storage service for data archiving, backup, and long-term data retention. • Retrieving tapes – You can't read archived tapes directly. To read an archived tape, you must first retrieve it to your Tape Gateway by using either the Storage Gateway console or the Storage Gateway API. Important If you archive a tape in S3 Glacier Flexible Retrieval, you can retrieve the tape typically within 3-5 hours. If you archive the tape in S3 Glacier Deep Archive, you can retrieve it typically within 12 hours. After you deploy and activate a Tape Gateway, you mount the virtual tape drives and media changer on your on-premises application servers as iSCSI devices. You create virtual tapes as needed. Then you use your existing backup software application to write data to the virtual tapes. Tape Gateways API Version 2013-06-30 3 AWS Storage Gateway Tape Gateway User Guide The media changer loads and unloads the virtual tapes into the virtual tape drives for read and write operations. Allocating local disks for the gateway VM Your gateway VM needs local disks, which you allocate for the following purposes: • Cache storage – The cache storage acts as the durable store for data that is waiting to upload to Amazon S3 from the upload buffer. If your application reads data from a virtual tape, the gateway saves the data to the cache storage. The gateway stores recently accessed data in the cache storage for low-latency access. If your application requests tape data, the gateway first checks the cache storage for the data before downloading the data from AWS. • Upload buffer – The upload buffer provides a staging area for the gateway before it uploads the data to a virtual tape. The upload buffer is also critical for creating recovery points that you can use to recover tapes from unexpected failures. For more information, see You Need to Recover a Virtual Tape from a Malfunctioning Tape Gateway. As your backup application writes data to your gateway, the gateway copies data to both the cache storage and the upload buffer. It then acknowledges completion of the write operation to your backup application. For guidelines on the amount of disk space to allocate for the cache storage and upload buffer, see Deciding the amount of local disk storage. Tape Gateways API Version 2013-06-30 4 AWS Storage Gateway Tape Gateway User Guide Getting started with AWS Storage Gateway This section provides instructions for getting started with AWS. You need an AWS account before you can start using AWS Storage Gateway. You can use an existing AWS account, or sign up for a new account. You also need an IAM user in your AWS account that belongs to a group with the necessary administrative permissions to perform Storage Gateway tasks. Users with the appropriate privileges can access the Storage Gateway console and Storage Gateway API to perform gateway deployment, configuration, and maintenance tasks. If you are a first-time user, we recommend that you review the Supported AWS regions and Tape Gateway setup requirements sections before you being working with Storage Gateway. This section contains the following topics, which provide additional information about getting started with AWS Storage Gateway: Topics • Sign Up for AWS Storage Gateway - Learn how to sign up for AWS and create an AWS account. • Create an IAM user with administrator privileges - Learn how to create an IAM user with administrative privileges for your AWS account. • Accessing AWS Storage Gateway - Learn how to access AWS Storage Gateway through the Storage Gateway console or programmatically using the AWS SDKs. • AWS Regions that support Storage Gateway - Learn which AWS Regions you can use to store your data when you activate your gateway in Storage Gateway. Sign Up for AWS Storage Gateway An AWS account is a fundamental requirement for accessing AWS services. Your AWS account is the basic container for all of the AWS resources you create as an AWS user. Your AWS account is also the basic security boundary for your AWS resources. Any resources that you create in your account are available to users who have credentials for the account. Before you can start using AWS Storage Gateway, you need to sign up for an AWS account. If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account 1. Open https://portal.aws.amazon.com/billing/signup. Sign Up for AWS Storage Gateway API Version 2013-06-30 5 AWS Storage Gateway Tape Gateway User Guide 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering
|
storagegateway-tgw-ug-006
|
storagegateway-tgw-ug.pdf
| 6 |
security boundary for your AWS resources. Any resources that you create in your account are available to users who have credentials for the account. Before you can start using AWS Storage Gateway, you need to sign up for an AWS account. If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account 1. Open https://portal.aws.amazon.com/billing/signup. Sign Up for AWS Storage Gateway API Version 2013-06-30 5 AWS Storage Gateway Tape Gateway User Guide 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a verification code on the phone keypad. When you sign up for an AWS account, an AWS account root user is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform tasks that require root user access. We also recommend that you require your users to use temporary credentials when accessing AWS. To provide temporary credentials, you can use federation and an identity provider, such as AWS IAM Identity Center. If your company already uses an identity provider, you can use it with federation to simplify how you provide access to the resources in your AWS account. Create an IAM user with administrator privileges After you create your AWS account, use the following steps to create an AWS Identity and Access Management (IAM) user for yourself, and then add that user to a group that has administrative permissions. For more information about using the AWS Identity and Access Management service to control access to Storage Gateway resources, see Identity and Access Management for AWS Storage Gateway. To create an administrator user, choose one of the following options. To By You can also Choose one way to manage your administr ator In IAM Identity Use short-term credentials to access Following the instructions in Getting started in the Configure programmatic access by Configuring the Center AWS. AWS IAM Identity Center AWS CLI to use AWS IAM User Guide. Identity Center in the AWS Create an IAM user with administrator privileges API Version 2013-06-30 6 AWS Storage Gateway Tape Gateway User Guide To By You can also Choose one way to manage your administr ator (Recommen This aligns with the Command Line Interface User ded) security best practices . For information about best practices , see Security best practices in IAM in the IAM User Guide. Guide. In IAM (Not Use long-term credentials to access Following the instructions in Create an IAM user for Configure programmatic access by Manage access keys AWS. emergency access in the for IAM users in the IAM User IAM User Guide. Guide. recommend ed) Warning IAM users have long-term credentials which present a security risk. To help mitigate this risk, we recommend that you provide these users with only the permissions they require to perform the task and that you remove these users when they are no longer needed. Accessing AWS Storage Gateway You can use the AWS Storage Gateway console to perform various gateway configuration and maintenance tasks, including activating or removing Storage Gateway hardware appliances from your deployment, creating, managing, and deleting the different types of gateways, creating, managing, and deleting tapes in your virtual tape library, and monitoring the health and status of various elements of the Storage Gateway service. For simplicity and ease of use, this guide focuses on performing tasks using the Storage Gateway console web interface. You can access the Storage Accessing AWS Storage Gateway API Version 2013-06-30 7 AWS Storage Gateway Tape Gateway User Guide Gateway console through your web browser at: https://console.aws.amazon.com/storagegateway/ home/. If you prefer a programmatic approach, you can use the AWS Storage Gateway Application Programming Interface (API) or Command Line Interface (CLI) to set up and manage the resources in your Storage Gateway deployment. For more information about actions, data types, and required syntax for the Storage Gateway API, see the Storage Gateway API Reference. For more information about the Storage Gateway CLI, see the AWS CLI Command Reference. You can also use the AWS SDKs to develop applications that interact with Storage Gateway. The AWS SDKs for Java, .NET, and PHP wrap the underlying Storage Gateway API to simplify your programming tasks. For information about downloading the SDK libraries, see the AWS Developer Center. For information about pricing, see AWS Storage Gateway pricing. AWS Regions that support Storage Gateway An AWS Region is a physical location in the world where AWS has multiple Availability Zones. Availability Zones consist of one or more discrete AWS data centers, each with redundant power, networking, and connectivity, housed in separate facilities. This means that each AWS Region is physically isolated and independent of the other Regions.
|
storagegateway-tgw-ug-007
|
storagegateway-tgw-ug.pdf
| 7 |
Gateway. The AWS SDKs for Java, .NET, and PHP wrap the underlying Storage Gateway API to simplify your programming tasks. For information about downloading the SDK libraries, see the AWS Developer Center. For information about pricing, see AWS Storage Gateway pricing. AWS Regions that support Storage Gateway An AWS Region is a physical location in the world where AWS has multiple Availability Zones. Availability Zones consist of one or more discrete AWS data centers, each with redundant power, networking, and connectivity, housed in separate facilities. This means that each AWS Region is physically isolated and independent of the other Regions. Regions provide fault tolerance, stability, and resilience, and can also reduce latency. The resources that you create in one Region do not exist in any other Region unless you explicitly use a replication feature offered by an AWS service. For example, Amazon S3 and Amazon EC2 support cross-Region replication. Some services, such as AWS Identity and Access Management, do not have Regional resources. You can launch AWS resources in locations that meet your business requirements. For example, you might want to launch Amazon EC2 instances to host your AWS Storage Gateway appliances in an AWS Region in Europe to be closer to your European users, or to meet legal requirements. Your AWS account determines which of the Regions supported by a specific service are available for you to use. • Storage Gateway—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. • Storage Gateway Hardware Appliance—For supported AWS Regions you can use with the hardware appliance, see AWS Storage Gateway Hardware Appliance Regions in the AWS General Reference. AWS Regions that support Storage Gateway API Version 2013-06-30 8 AWS Storage Gateway Tape Gateway User Guide Requirements for setting up Tape Gateway Unless otherwise noted, the following requirements are common to all gateway configurations. Topics • Hardware and storage requirements • Network and firewall requirements • Supported hypervisors and host requirements • Supported iSCSI initiators • Supported third-party backup applications for a Tape Gateway Hardware and storage requirements This section describes the minimum hardware and settings for your gateway and the minimum amount of disk space to allocate for the required storage. Hardware requirements for VMs When deploying your gateway, you must make sure that the underlying hardware on which you deploy the gateway VM can dedicate the following minimum resources: • Four virtual processors assigned to the VM. • For Tape Gateway, your hardware should dedicate the following amounts of RAM: • 16 GiB of reserved RAM for gateways with cache size up to 16 TiB • 32 GiB of reserved RAM for gateways with cache size 16 TiB to 32 TiB • 48 GiB of reserved RAM for gateways with cache size 32 TiB to 64 TiB • 80 GiB of disk space for installation of VM image and system data. For more information, see Optimizing gateway performance. For information about how your hardware affects the performance of the gateway VM, see AWS Storage Gateway quotas. Hardware and storage requirements API Version 2013-06-30 9 AWS Storage Gateway Tape Gateway User Guide Requirements for Amazon EC2 instance types When deploying your gateway on Amazon Elastic Compute Cloud (Amazon EC2), the instance size must be at least xlarge for your gateway to function. However, for the compute-optimized instance family the size must be at least 2xlarge. Note The Storage Gateway AMI is only compatible with x86-based instances that use Intel or AMD processors. ARM-based instances that use Graviton processors are not supported. For Tape Gateway, your Amazon EC2 instance should dedicate the following amounts of RAM depending on the cache size you plan to use for your gateway: • 16 GiB of reserved RAM for gateways with cache size up to 16 TiB • 32 GiB of reserved RAM for gateways with cache size 16 TiB to 32 TiB • 48 GiB of reserved RAM for gateways with cache size 32 TiB to 64 TiB Use one of the following instance types recommended for your gateway type. Recommended for Tape Gateway • General-purpose instance family – m4, m5, or m6 instance type. • Compute-optimized instance family – c4, c5, c6, or c7 instance types. Choose the 2xlarge instance size or higher to meet the required RAM requirements. • Memory-optimized instance family – r3, r5, r6, or r7 instance types. • Storage-optimized instance family – i3, i4, or i7 instance types. Storage requirements In addition to 80 GiB disk space for the VM, you also need additional disks for your gateway. The following table recommends sizes for local disk storage for your deployed gateway. Requirements for Amazon EC2 instance types API Version 2013-06-30 10 AWS Storage Gateway Tape Gateway User Guide Gateway Type
|
storagegateway-tgw-ug-008
|
storagegateway-tgw-ug.pdf
| 8 |
• Compute-optimized instance family – c4, c5, c6, or c7 instance types. Choose the 2xlarge instance size or higher to meet the required RAM requirements. • Memory-optimized instance family – r3, r5, r6, or r7 instance types. • Storage-optimized instance family – i3, i4, or i7 instance types. Storage requirements In addition to 80 GiB disk space for the VM, you also need additional disks for your gateway. The following table recommends sizes for local disk storage for your deployed gateway. Requirements for Amazon EC2 instance types API Version 2013-06-30 10 AWS Storage Gateway Tape Gateway User Guide Gateway Type Cache (Minimum) Cache (Maximum) Upload Buffer Upload Buffer Other Required (Minimum) (Maximum) Local Disks 150 GiB 64 TiB 150 GiB 2 TiB — Tape Gateway Note You can configure one or more local drives for your cache and upload buffer, up to the maximum capacity. When adding cache or upload buffer to an existing gateway, it's important to create new disks in your host (hypervisor or Amazon EC2 instance). Don't change the size of existing disks if the disks have been previously allocated as either a cache or upload buffer. For information about gateway quotas, see AWS Storage Gateway quotas. Network and firewall requirements Your gateway requires access to the internet, local networks, Domain Name Service (DNS) servers, firewalls, routers, and so on. Following, you can find information about required ports and how to allow access through firewalls and routers. Note In some cases, you might deploy Storage Gateway on Amazon EC2 or use other types of deployment (including on-premises) with network security policies that restrict AWS IP address ranges. In these cases, your gateway might experience service connectivity issues when the AWS IP range values changes. The AWS IP address range values that you need to use are in the Amazon service subset for the AWS Region that you activate your gateway in. For the current IP range values, see AWS IP address ranges in the AWS General Reference. Network and firewall requirements API Version 2013-06-30 11 AWS Storage Gateway Note Tape Gateway User Guide Network bandwidth requirements vary based on the quantity of data that is uploaded and downloaded by the gateway. A minimum of 100Mbps is required to successfully download, activate, and update the gateway. Your data transfer patterns will determine the bandwidth necessary to support your workload. In some cases, you might deploy Storage Gateway on Amazon EC2 or use other types of deployment Topics • Port requirements • Networking and firewall requirements for the Storage Gateway Hardware Appliance • Allowing AWS Storage Gateway access through firewalls and routers • Configuring security groups for your Amazon EC2 gateway instance Port requirements Tape Gateway requires specific ports to be allowed through your network security for successful deployment and operation. Some ports are required for all gateways, while others are required only for specific configurations, such as when connecting to VPC endpoints. Port requirements for Tape Gateway Network Element Web browser From To Protocol Port Inbound Outbound Required Notes Your web browser Storage Gateway VM TCP HTTP 80 ✓ ✓ ✓ Used by local systems to obtain the Storage Gateway activatio n key. Port requirements API Version 2013-06-30 12 AWS Storage Gateway Tape Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes Port 80 is used only during activatio n of a Storage Gateway appliance . A Storage Gateway VM doesn't require port 80 to be publicly accessibl e. The required level of access to port 80 depends on your network configura tion. If you activate your gateway Port requirements API Version 2013-06-30 13 AWS Storage Gateway Tape Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes from the Storage Gateway Managemen t Console, the host from which you connect to the console must have access to your gateway's port 80. AWS Managemen t Console (all other operation s) Web browser Storage Gateway AWS TCP HTTPS VM 443 ✓ ✓ ✓ Port requirements API Version 2013-06-30 14 AWS Storage Gateway Tape Gateway User Guide Network Element DNS From To Protocol Port Inbound Outbound Required Notes 53 ✓ ✓ ✓ Storage Gateway Domain Name TCP & UDP VM Service DNS (DNS) server Used for communica tion between a Storage Gateway VM and the DNS server for IP name resolutio n. Port requirements API Version 2013-06-30 15 AWS Storage Gateway Tape Gateway User Guide Network Element NTP From To Protocol Port Inbound Outbound Required Notes 123 ✓ ✓ ✓ Storage Gateway Network Time TCP & UDP VM Protocol NTP (NTP) server Used by on- premis es systems to synchroni ze VM time to the host time. A Storage Gateway VM is configure d to use the following NTP servers: • 0.amazon. pool.ntp. org • 1.amazon. pool.ntp. org • 2.amazon. pool.ntp. org Port
|
storagegateway-tgw-ug-009
|
storagegateway-tgw-ug.pdf
| 9 |
server Used for communica tion between a Storage Gateway VM and the DNS server for IP name resolutio n. Port requirements API Version 2013-06-30 15 AWS Storage Gateway Tape Gateway User Guide Network Element NTP From To Protocol Port Inbound Outbound Required Notes 123 ✓ ✓ ✓ Storage Gateway Network Time TCP & UDP VM Protocol NTP (NTP) server Used by on- premis es systems to synchroni ze VM time to the host time. A Storage Gateway VM is configure d to use the following NTP servers: • 0.amazon. pool.ntp. org • 1.amazon. pool.ntp. org • 2.amazon. pool.ntp. org Port requirements API Version 2013-06-30 16 AWS Storage Gateway Tape Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes • 3.amazon. pool.ntp. org Note Not required for gateways hosted on Amazon EC2. Port requirements API Version 2013-06-30 17 AWS Storage Gateway Tape Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes Storage Gateway Storage Gateway Support Endpoint TCP SSH VM 22 ✓ ✓ ✓ Allows Support to access your gateway to help you with troublesh ooting gateway issues. You don't need this port open for the normal operation of your gateway, but it is required for troublesh ooting. For a list of support endpoints Port requirements API Version 2013-06-30 18 AWS Storage Gateway Tape Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes Storage Gateway Storage Gateway AWS TCP HTTPS 443 VM Amazon CloudFron t Storage Gateway VM VPC Storage Gateway VM AWS AWS TCP HTTPS 443 TCP HTTPS 443 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓* VPC AWS Storage Gateway VM TCP HTTPS 1026 ✓ ✓* , see Support endpoints . Managemen t control For activatio n Managemen t control *Required only when using VPC endpoints Control Plane endpoint *Required only when using VPC endpoints Port requirements API Version 2013-06-30 19 AWS Storage Gateway Tape Gateway User Guide From To Protocol Port Inbound Outbound Required Notes Network Element VPC AWS Storage Gateway VM TCP HTTPS 1027 ✓ ✓* Anon Control Plane (for activatio n) *Required only when using VPC endpoints Proxy endpoint *Required only when using VPC endpoints Data Plane *Required only when using VPC endpoints VPC AWS Storage Gateway VM TCP HTTPS 1028 ✓ ✓* VPC AWS Storage Gateway VM TCP HTTPS 1031 ✓ ✓* Port requirements API Version 2013-06-30 20 AWS Storage Gateway Tape Gateway User Guide From To Protocol Port Inbound Outbound Required Notes Network Element VPC AWS Storage Gateway VM TCP HTTPS 2222 ✓ ✓* VPC AWS Storage Gateway VM TCP HTTPS 443 ✓ ✓ ✓* SSH Support Channel for VPCe *Required only for opening support channel when using VPC endpoints Managemen t control *Required only when using VPC endpoints Port requirements API Version 2013-06-30 21 AWS Storage Gateway Tape Gateway User Guide Network Element From To Protocol Port Inbound Outbound Required Notes iSCSI Client iSCSI client Storage Gateway VM TCP 3260 ✓ ✓ ✓ For local systems to connect to iSCSI targets exposed by the gateway. The following illustration shows network traffic flow for a basic Tape Gateway deployment. Port requirements API Version 2013-06-30 22 AWS Storage Gateway Tape Gateway User Guide Networking and firewall requirements for the Storage Gateway Hardware Appliance Each Storage Gateway Hardware Appliance requires the following network services: • Internet access – an always-on network connection to the internet through any network interface on the server. • DNS services – DNS services for communication between the hardware appliance and DNS server. • Time synchronization – an automatically configured Amazon NTP time service must be reachable. • IP address – A DHCP or static IPv4 address assigned. You cannot assign an IPv6 address. There are five physical network ports at the rear of the Dell PowerEdge R640 server. From left to right (facing the back of the server) these ports are as follows: 1. iDRAC 2. em1 3. em2 4. em3 5. em4 You can use the iDRAC port for remote server management. A hardware appliance requires the following ports to operate. Networking and firewall requirements for the hardware appliance API Version 2013-06-30 23 AWS Storage Gateway Tape Gateway User Guide Protocol Port Direction Source Destination SSH DNS 22 53 Outbound Outbound UDP/NTP 123 Outbound Hardware appliance Hardware appliance Hardware appliance 54.201.22 3.107 DNS servers *.amazon. pool.ntp. org How Used Support channel Name resolutio n Time synchroni zation HTTPS 443 Outbound Hardware appliance *.amazona ws.com Data transfer HTTP 8080 Inbound AWS Hardware appliance Activatio n (only briefly) To perform as designed, a hardware appliance requires network and firewall settings as follows: • Configure all connected network interfaces in the hardware console. • Make sure that each network interface is on a unique subnet. • Provide all connected network interfaces with outbound access to the endpoints listed in the
|
storagegateway-tgw-ug-010
|
storagegateway-tgw-ug.pdf
| 10 |
22 53 Outbound Outbound UDP/NTP 123 Outbound Hardware appliance Hardware appliance Hardware appliance 54.201.22 3.107 DNS servers *.amazon. pool.ntp. org How Used Support channel Name resolutio n Time synchroni zation HTTPS 443 Outbound Hardware appliance *.amazona ws.com Data transfer HTTP 8080 Inbound AWS Hardware appliance Activatio n (only briefly) To perform as designed, a hardware appliance requires network and firewall settings as follows: • Configure all connected network interfaces in the hardware console. • Make sure that each network interface is on a unique subnet. • Provide all connected network interfaces with outbound access to the endpoints listed in the diagram preceding. • Configure at least one network interface to support the hardware appliance. For more information, see Configuring hardware appliance network parameters. Note For an illustration showing the back of the server with its ports, see Physically installing your hardware appliance Networking and firewall requirements for the hardware appliance API Version 2013-06-30 24 AWS Storage Gateway Tape Gateway User Guide All IP addresses on the same network interface (NIC), whether for a gateway or a host, must be on the same subnet. The following illustration shows the addressing scheme. For more information on activating and configuring a hardware appliance, see Using the Storage Gateway Hardware Appliance. Allowing AWS Storage Gateway access through firewalls and routers Your gateway requires access to the following service endpoints to communicate with AWS. If you use a firewall or router to filter or limit network traffic, you must configure your firewall and router to allow these service endpoints for outbound communication to AWS. Allowing gateway access through firewall and routers API Version 2013-06-30 25 AWS Storage Gateway Note Tape Gateway User Guide If you configure private VPC endpoints for your Storage Gateway to use for connection and data transfer to and from AWS, your gateway does not require access to the public internet. For more information, see Activating a gateway in a virtual private cloud. Important Depending on your gateway's AWS Region, replace region in the service endpoint with the correct region string. The following service endpoints are required by all gateways for control path (anon-cp, client-cp, proxy-app) and data path (dp-1) operations. anon-cp.storagegateway.region.amazonaws.com:443 client-cp.storagegateway.region.amazonaws.com:443 proxy-app.storagegateway.region.amazonaws.com:443 dp-1.storagegateway.region.amazonaws.com:443 The following gateway service endpoint is required to make API calls. storagegateway.region.amazonaws.com:443 The following example is a gateway service endpoint in the US West (Oregon) Region (us- west-2). storagegateway.us-west-2.amazonaws.com:443 A Storage Gateway VM is configured to use the following NTP servers. 0.amazon.pool.ntp.org 1.amazon.pool.ntp.org 2.amazon.pool.ntp.org 3.amazon.pool.ntp.org Allowing gateway access through firewall and routers API Version 2013-06-30 26 AWS Storage Gateway Tape Gateway User Guide • Storage Gateway—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. • Storage Gateway Hardware Appliance—For supported AWS Regions you can use with the hardware appliance see Storage Gateway hardware appliance regions in the AWS General Reference. Configuring security groups for your Amazon EC2 gateway instance A security group controls traffic to your Amazon EC2 gateway instance. When you configure a security group, we recommend the following: • The security group should not allow incoming connections from the outside internet. It should allow only instances within the gateway security group to communicate with the gateway. If you need to allow instances to connect to the gateway from outside its security group, we recommend that you allow connections only on ports 3260 (for iSCSI connections) and 80 (for activation). • If you want to activate your gateway from an Amazon EC2 host outside the gateway security group, allow incoming connections on port 80 from the IP address of that host. If you cannot determine the activating host's IP address, you can open port 80, activate your gateway, and then close access on port 80 after completing activation. • Allow port 22 access only if you are using Support for troubleshooting purposes. For more information, see You want Support to help troubleshoot your EC2 gateway. In some cases, you might use an Amazon EC2 instance as an initiator (that is, to connect to iSCSI targets on a gateway that you deployed on Amazon EC2. In such a case, we recommend a two-step approach: 1. You should launch the initiator instance in the same security group as your gateway. 2. You should configure access so the initiator can communicate with your gateway. For information about the ports to open for your gateway, see Port requirements. Configuring security group API Version 2013-06-30 27 AWS Storage Gateway Tape Gateway User Guide Supported hypervisors and host requirements You can run Storage Gateway on-premises as either a virtual machine (VM) appliance, or a physical hardware appliance, or in AWS as an Amazon EC2 instance. Note When a manufacturer ends general support for a hypervisor version, Storage Gateway also ends support for
|
storagegateway-tgw-ug-011
|
storagegateway-tgw-ug.pdf
| 11 |
launch the initiator instance in the same security group as your gateway. 2. You should configure access so the initiator can communicate with your gateway. For information about the ports to open for your gateway, see Port requirements. Configuring security group API Version 2013-06-30 27 AWS Storage Gateway Tape Gateway User Guide Supported hypervisors and host requirements You can run Storage Gateway on-premises as either a virtual machine (VM) appliance, or a physical hardware appliance, or in AWS as an Amazon EC2 instance. Note When a manufacturer ends general support for a hypervisor version, Storage Gateway also ends support for that hypervisor version. For detailed information about support for specific versions of a hypervisor, see the manufacturer's documentation. Storage Gateway supports the following hypervisor versions and hosts: • VMware ESXi Hypervisor (version 7.0 or 8.0) – For this setup, you also need a VMware vSphere client to connect to the host. • Microsoft Hyper-V Hypervisor (version 2012 R2, 2016, 2019, or 2022) – A free, standalone version of Hyper-V is available at the Microsoft Download Center. For this setup, you need a Microsoft Hyper-V Manager on a Microsoft Windows client computer to connect to the host. • Linux Kernel-based Virtual Machine (KVM) – A free, open-source virtualization technology. KVM is included in all versions of Linux version 2.6.20 and newer. Storage Gateway is tested and supported for the CentOS/RHEL 7.7, Ubuntu 16.04 LTS, and Ubuntu 18.04 LTS distributions. Any other modern Linux distribution may work, but function or performance is not guaranteed. We recommend this option if you already have a KVM environment up and running and you are already familiar with how KVM works. • Amazon EC2 instance – Storage Gateway provides an Amazon Machine Image (AMI) that contains the gateway VM image. Only file, cached volume, and Tape Gateway types can be deployed on Amazon EC2. For information about how to deploy a gateway on Amazon EC2, see Deploy a customized Amazon EC2 instance for Tape Gateway. • Storage Gateway Hardware Appliance – Storage Gateway provides a physical hardware appliance as a on-premises deployment option for locations with limited virtual machine infrastructure. Note Storage Gateway doesn’t support recovering a gateway from a VM that was created from a snapshot or clone of another gateway VM or from your Amazon EC2 AMI. If your gateway Supported hypervisors and host requirements API Version 2013-06-30 28 AWS Storage Gateway Tape Gateway User Guide VM malfunctions, activate a new gateway and recover your data to that gateway. For more information, see Recovering from an unexpected virtual machine shutdown. Storage Gateway doesn’t support dynamic memory and virtual memory ballooning. Supported iSCSI initiators When you deploy a Tape Gateway, the gateway is preconfigured with one media changer and 10 tape drives. These tape drives and the media changer are available to your existing client backup applications as iSCSI devices. To connect to these iSCSI devices, Storage Gateway supports the following iSCSI initiators: • Microsoft Windows Server 2022 • Red Hat Enterprise Linux 8 • Red Hat Enterprise Linux 9 • VMware ESX Initiator, which provides an alternative to using initiators in the guest operating systems of your VMs Important Storage Gateway doesn't support Microsoft Multipath I/O (MPIO) from Windows clients. Storage Gateway supports connecting multiple hosts to the same volume if the hosts coordinate access by using Windows Server Failover Clustering (WSFC). However, you can't connect multiple hosts to that same volume (for example, sharing a nonclustered NTFS/ ext4 file system) without using WSFC. Supported third-party backup applications for a Tape Gateway You use a backup application to read, write, and manage tapes with a Tape Gateway. The type of medium changer you choose depends on the backup application you plan to use. AWS has tested the third-party backup applications in the following table to ensure compatibility with these Tape Gateway features and functions: Supported iSCSI initiators API Version 2013-06-30 29 AWS Storage Gateway Tape Gateway User Guide • Discovery functionality including iSCSI initiator connectivity, medium changer, rescan, automatic and manual device mapping. • Tape functions including create, delete, import, export, inventory, and barcode visibility. • Erasure of tape content and verification that subsequent restores contain no data. • Data backup to single and multiple tapes, verification that backup jobs exceeding tape capacity will pause to wait for additional tapes. • Restoration of full and partial data from tapes and verification of data integrity. • Verification of functionality and data integrity after gateway shutdown and restart events during backup operations. Backup Application Version Medium Changer Type Gateway Version Tested Arcserve Backup 19 AWS-Gateway-VTL 2.12.3 Bacula Enterprise 15.0.2 AWS-Gateway-VTL or STK-L700 2.12.3 Commvault 2024E / 11.36.35 STK-L700 2.12.3 Dell EMC NetWorker 19.10 AWS-Gateway-VTL 2.12.3 IBM Storage Protect 8.1.10 IBM-03584L32-0402 All Micro Focus Data Protector Microsoft System Center Data Protectio n Manager 24.4 2025 NovaStor DataCenter
|
storagegateway-tgw-ug-012
|
storagegateway-tgw-ug.pdf
| 12 |
multiple tapes, verification that backup jobs exceeding tape capacity will pause to wait for additional tapes. • Restoration of full and partial data from tapes and verification of data integrity. • Verification of functionality and data integrity after gateway shutdown and restart events during backup operations. Backup Application Version Medium Changer Type Gateway Version Tested Arcserve Backup 19 AWS-Gateway-VTL 2.12.3 Bacula Enterprise 15.0.2 AWS-Gateway-VTL or STK-L700 2.12.3 Commvault 2024E / 11.36.35 STK-L700 2.12.3 Dell EMC NetWorker 19.10 AWS-Gateway-VTL 2.12.3 IBM Storage Protect 8.1.10 IBM-03584L32-0402 All Micro Focus Data Protector Microsoft System Center Data Protectio n Manager 24.4 2025 NovaStor DataCenter 9.5.3 Quest NetVault Backup 13.3 AWS-Gateway-VTL 2.12.3 STK-L700 2.12.3 STK-L700 STK-L700 2.12.3 2.12.3 Supported third-party backup applications API Version 2013-06-30 30 AWS Storage Gateway Tape Gateway User Guide Backup Application Version Medium Changer Type Gateway Version Tested Veeam Backup & Replication 12 AWS-Gateway-VTL All Veritas Backup Exec 24 AWS-Gateway-VTL All Veritas NetBackup 10.5 AWS-Gateway-VTL 2.12.3 Important We highly recommend that you choose the medium changer that's listed for your backup application. Other medium changers might not function properly. You can choose a different medium changer after the gateway is activated. For more information, see Selecting a Medium Changer After Gateway Activation. Supported third-party backup applications API Version 2013-06-30 31 AWS Storage Gateway Tape Gateway User Guide Using the Storage Gateway Hardware Appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. The Storage Gateway Hardware Appliance is a physical hardware appliance with the Storage Gateway software preinstalled on a validated server configuration. You can manage the hardware appliances in your deployment from the Hardware appliance overview page in the AWS Storage Gateway console. The hardware appliance is a high-performance 1U server that you can deploy in your data center, or on-premises inside your corporate firewall. When you buy and activate your hardware appliance, the activation process associates the hardware appliance with your AWS account. After activation, your hardware appliance appears in the console on the Hardware appliance overview page. You can configure the hardware appliance as an S3 File Gateway, FSx File Gateway, Tape Gateway, or Volume Gateway type. The procedure that you use to deploy these gateway types on a hardware appliance is same as on a virtual platform. For a list of supported AWS Regions where the Storage Gateway Hardware Appliance is available for activation and use, see Storage Gateway Hardware Appliance Regions in the AWS General Reference. In the sections that follow, you can find instructions about how to set up, rack mount, power, configure, activate, launch, use, and delete an Storage Gateway Hardware Appliance. Topics • Setting up your Storage Gateway Hardware Appliance • Physically installing your hardware appliance • Accessing the hardware appliance console • Configuring hardware appliance network parameters • Activating your Storage Gateway Hardware Appliance API Version 2013-06-30 32 AWS Storage Gateway Tape Gateway User Guide • Creating a gateway on your hardware appliance • Configuring a gateway IP address on the hardware appliance • Removing gateway software from your hardware appliance • Deleting your Storage Gateway Hardware Appliance Setting up your Storage Gateway Hardware Appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. After you receive your Storage Gateway Hardware Appliance, you use the hardware appliance local console to configure networking to provide an always-on connection to AWS and activate your appliance. Activation associates your appliance with the AWS account that is used during the activation process. After the appliance is activated, you can launch an S3 File Gateway, FSx File Gateway, Tape Gateway, or Volume Gateway from the Storage Gateway console. To install and configure your hardware appliance 1. Rack-mount the appliance, and plug in power and network connections. For more information, see Physically installing your hardware appliance. 2. Set the Internet Protocol version 4 (IPv4) addresses for the hardware appliance (the host). For more information, see Configuring hardware appliance network parameters. 3. Activate the hardware appliance on the console Hardware appliance overview page in the AWS Region of your choice. For more information, see Activating your Storage Gateway Hardware Appliance. 4. Create a gateway on your hardware appliance. For more information, see Create and activate a Tape
|
storagegateway-tgw-ug-013
|
storagegateway-tgw-ug.pdf
| 13 |
Storage Gateway console. To install and configure your hardware appliance 1. Rack-mount the appliance, and plug in power and network connections. For more information, see Physically installing your hardware appliance. 2. Set the Internet Protocol version 4 (IPv4) addresses for the hardware appliance (the host). For more information, see Configuring hardware appliance network parameters. 3. Activate the hardware appliance on the console Hardware appliance overview page in the AWS Region of your choice. For more information, see Activating your Storage Gateway Hardware Appliance. 4. Create a gateway on your hardware appliance. For more information, see Create and activate a Tape Gateway. You set up gateways on your hardware appliance the same way that you set up gateways on VMware ESXi, Microsoft Hyper-V, Linux Kernel-based Virtual Machine (KVM), or Amazon EC2. Setting up your hardware appliance API Version 2013-06-30 33 AWS Storage Gateway Tape Gateway User Guide Increasing the usable cache storage You can increase the usable storage on the hardware appliance from 5 TB to 12 TB. Doing this provides a larger cache for low latency access to data in AWS. If you ordered the 5 TB model, you can increase the usable storage to 12 TB by buying five 1.92 TB SSDs (solid state drives). You can then add them to the hardware appliance before you activate it. If you have already activated the hardware appliance and want to increase the usable storage on the appliance to 12 TB, do the following: 1. Reset the hardware appliance to its factory settings. Contact AWS Support for instructions on how to do this. 2. Add five 1.92 TB SSDs to the appliance. Network interface card options Depending on the model of appliance you ordered, it may come with a 10G-Base-T RJ45 copper, or a 10G DA/SFP+ network card. • 10G-Base-T NIC configuration: • Use CAT6 cables for 10G or CAT5(e) for 1G • 10G DA/SFP+ NIC configuration: • Use Twinax copper Direct Attach Cables up to 5 meters • Dell/Intel compatible SFP+ optical modules (SR or LR) • SFP/SFP+ copper transceiver for 1G-Base-T or 10G-Base-T Physically installing your hardware appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. Physically installing your hardware appliance API Version 2013-06-30 34 AWS Storage Gateway Tape Gateway User Guide Your appliance has a 1U form factor and fits in a standard International Electrotechnical Commission (IEC) compliant 19-inch rack. Prerequisites To install your hardware appliance, you need the following components: • Power cables: one required, two recommended. • Supported network cabling (depending on which Network Interface Card (NIC) is included in the hardware appliance). Twinax Copper DAC, SFP+ optical module (Intel compatible) or SFP to Base- T copper transceiver. • Keyboard and monitor, or a keyboard, video, and mouse (KVM) switch solution. Note Before you perform the following procedure, make sure that you meet all of the requirements for the Storage Gateway Hardware Appliance as described in Networking and firewall requirements for the Storage Gateway Hardware Appliance. To physically install your hardware appliance 1. Unbox your hardware appliance and follow the instructions contained in the box to rack- mount the server. The following image shows the back of the hardware appliance with ports for connecting power, ethernet, monitor, USB keyboard, and iDRAC. hardware appliance one rear with network and power connector labels. hardware appliance one rear with network and power connector labels. 2. Plug in a power connection to each of the two power supplies. It's possible to plug in to only one power connection, but we recommend power connections to both power supplies for redundancy. Physically installing your hardware appliance API Version 2013-06-30 35 AWS Storage Gateway Tape Gateway User Guide 3. Plug an Ethernet cable into the em1 port to provide an always-on internet connection. The em1 port is the first of the four physical network ports on the rear, from left to right. Note The hardware appliance doesn't support VLAN trunking. Set up the switch port to which you are connecting the hardware appliance as a non-trunked VLAN port. 4. Plug in the keyboard and monitor. 5. Power on the server by pressing the Power button on the front panel, as shown in the following image. hardware appliance front with power button label. hardware appliance front with power button label. Next step Accessing the hardware appliance console Accessing the hardware appliance console Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the
|
storagegateway-tgw-ug-014
|
storagegateway-tgw-ug.pdf
| 14 |
doesn't support VLAN trunking. Set up the switch port to which you are connecting the hardware appliance as a non-trunked VLAN port. 4. Plug in the keyboard and monitor. 5. Power on the server by pressing the Power button on the front panel, as shown in the following image. hardware appliance front with power button label. hardware appliance front with power button label. Next step Accessing the hardware appliance console Accessing the hardware appliance console Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. Accessing the hardware appliance console API Version 2013-06-30 36 AWS Storage Gateway Tape Gateway User Guide When you power on your hardware appliance, the hardware appliance console appears on the monitor. The hardware appliance console presents a user interface specific to AWS that you can use to set an administrator password, configure initial network parameters, and open a support channel to AWS. To work with the hardware appliance console, enter text from the keyboard and use the Up, Down, Right, and Left Arrow keys to move about the screen in the indicated direction. Use the Tab key to move forward in order through items on-screen. On some setups, you can use the Shift +Tab keystroke to move sequentially backward. Use the Enter key to save selections, or to choose a button on the screen. The first time the hardware appliance console appears, the Welcome page is displayed, and you are prompted to set a password for the admin user account before you can access the console. To set an admin password • At the Please set your login password prompt, do the following: a. b. For Set Password, enter a password, and then press Down arrow. For Confirm, re-enter your password, and then choose Save Password. After you set your password, the hardware console Home page appears. The Home page displays network information for the em1, em2, em3, and em4 network interfaces, and has the following menu options: • Configure Network • Open Service Console • Change Password • Logout • Open Support Console Next step Configuring hardware appliance network parameters Accessing the hardware appliance console API Version 2013-06-30 37 AWS Storage Gateway Tape Gateway User Guide Configuring hardware appliance network parameters Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. After the hardware appliance boots up and you set your admin user password in the hardware console as described in Accessing the hardware appliance console, use the following procedure to configure network parameters so your hardware appliance can connect to AWS. To set a network address 1. From the Home page, choose Configure Network and then press Enter. The Configure Network page appears. The Configure Network page shows IP and DNS information for each of the 4 network interfaces on the hardware appliance, and includes menu options to configure DHCP or Static addresses for each. 2. For the em1 interface, do one of the following: • Choose DHCP and press Enter to use the IPv4 address assigned by your Dynamic Host Configuration Protocol (DHCP) server to your physical network port. Note this address for later use in the activation step. • Choose Static and press Enter to configure a static IPv4 address. Enter a valid IP Address, Subnet Mask, Gateway, and DNS server address for the em1 network interface. When finished, choose Save and then press Enter to save the configuration. Configuring hardware appliance network parameters API Version 2013-06-30 38 AWS Storage Gateway Note Tape Gateway User Guide You can use this procedure to configure other network interfaces in addition to em1. If you configure other interfaces, they must provide the same always-on connection to the AWS endpoints listed in the requirements. Network bonding and Link Aggregation Control Protocol (LACP) are not supported by the hardware appliance or by Storage Gateway. We do not recommend configuring multiple network interfaces on the same subnet as this can sometimes cause routing issues. To log out of the hardware console 1. Choose Back and press Enter to return to the Home page. 2. Choose Logout and press Enter to return to the Welcome page. Next step Activating your Storage Gateway Hardware Appliance Activating your Storage Gateway
|
storagegateway-tgw-ug-015
|
storagegateway-tgw-ug.pdf
| 15 |
you configure other interfaces, they must provide the same always-on connection to the AWS endpoints listed in the requirements. Network bonding and Link Aggregation Control Protocol (LACP) are not supported by the hardware appliance or by Storage Gateway. We do not recommend configuring multiple network interfaces on the same subnet as this can sometimes cause routing issues. To log out of the hardware console 1. Choose Back and press Enter to return to the Home page. 2. Choose Logout and press Enter to return to the Welcome page. Next step Activating your Storage Gateway Hardware Appliance Activating your Storage Gateway Hardware Appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. After configuring your IP address, you enter this IP address on the Hardware page of the AWS Storage Gateway console to activate your hardware appliance. The activation process registers the appliance to your AWS account. Activating your hardware appliance API Version 2013-06-30 39 AWS Storage Gateway Tape Gateway User Guide You can choose to activate your hardware appliance in any of the supported AWS Regions. For a list of supported AWS Regions, see Storage Gateway Hardware Appliance Regions in the AWS General Reference. To activate your Storage Gateway Hardware Appliance 1. Open the AWS Storage Gateway Management Console and sign in with the account credentials you want to use to activate your hardware. Note For activation only, the following must be true: • Your browser must be on the same network as your hardware appliance. • Your firewall must allow HTTP access on port 8080 to the appliance for inbound traffic. 2. Choose Hardware from the navigation menu on the left side of the page. 3. Choose Activate appliance. 4. For IP Address, enter the IP address that you configured for your hardware appliance, then choose Connect. 5. 6. For more information about configuring the IP address, see Configuring network parameters. For Name, enter a name for your hardware appliance. Names can be up to 255 characters long and can't include a slash character. For Hardware appliance time zone, enter the local time zone from which most of the workload for the gateway will be generated., then choose Next. The time zone controls when hardware updates take place, with 2 a.m. used as the default scheduled time to perform updates. Ideally, if the time zone is set properly, updates will take place outside of the local working day window by default. 7. Review the activation parameters in the Hardware appliance detail section. You can choose Previous to go back and make changes if necessary. Otherwise, choose Activate to finish the activation. A banner appears on the Hardware appliance overview page, indicating that the hardware appliance has been successfully activated. Activating your hardware appliance API Version 2013-06-30 40 AWS Storage Gateway Tape Gateway User Guide At this point, the appliance is associated with your account. The next step is to configure and launch an S3 File Gateway, FSx File Gateway, Tape Gateway, or Volume Gateway on the new appliance. Next step Creating a gateway on your hardware appliance Creating a gateway on your hardware appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. You can create an S3 File Gateway, FSx File Gateway, Tape Gateway, or Volume Gateway on any Storage Gateway Hardware Appliance in your deployment. To create a gateway on your hardware appliance 1. Sign in to the AWS Management Console and open the Storage Gateway console at https:// console.aws.amazon.com/storagegateway/home. 2. Follow the procedures described in Creating Your Gateway to set up, connect, and configure the type of Storage Gateway that you want to deploy. When you finish creating your gateway in the Storage Gateway console, the Storage Gateway software automatically starts installing on the hardware appliance. If you use Dynamic Host Configuration Protocol (DHCP), it can take 5 to 10 minutes for a gateway to display as online in the console. To assign a static IP address to your installed gateway, see Configuring an IP address for the gateway. To assign a static IP address to your installed gateway, you next configure the gateway's network interfaces so your applications can use it. Next step
|
storagegateway-tgw-ug-016
|
storagegateway-tgw-ug.pdf
| 16 |
the type of Storage Gateway that you want to deploy. When you finish creating your gateway in the Storage Gateway console, the Storage Gateway software automatically starts installing on the hardware appliance. If you use Dynamic Host Configuration Protocol (DHCP), it can take 5 to 10 minutes for a gateway to display as online in the console. To assign a static IP address to your installed gateway, see Configuring an IP address for the gateway. To assign a static IP address to your installed gateway, you next configure the gateway's network interfaces so your applications can use it. Next step Creating a gateway on your hardware appliance API Version 2013-06-30 41 AWS Storage Gateway Tape Gateway User Guide Configuring a gateway IP address on the hardware appliance Configuring a gateway IP address on the hardware appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. Before you activated your hardware appliance, you assigned an IP address to its physical network interface. Now that you have activated the appliance and launched your Storage Gateway on it, you need to assign another IP address to the Storage Gateway virtual machine that runs on the hardware appliance. To assign a static IP address to a gateway installed on your hardware appliance, configure the IP address from the gateway local console for that gateway. Your applications (such as your NFS or SMB client) connect to this IP address. You can access the gateway local console from the hardware appliance console using the Open Service Console option. To configure an IP address on your appliance to work with applications 1. On the hardware console, choose Open Service Console and then press Enter to open the login page for the gateway local console. 2. The AWS Storage Gateway local console login page prompts you to login to change your network configuration and other settings. The default account is admin and the default password is password. Note We recommend changing the default password by entering the corresponding numeral for Gateway Console from the AWS Appliance Activation - Configuration main menu, then running the passwd command. For information about how to run the command, see Running storage gateway commands in the local console for an on- premises gateway. You can also set the password from the Storage Gateway console. Configuring a gateway IP address on the hardware appliance API Version 2013-06-30 42 AWS Storage Gateway Tape Gateway User Guide For more information, see Setting the Local Console Password from the Storage Gateway Console. 3. The AWS Appliance Activation - Configuration page includes the following menu options: • HTTP/SOCKS Proxy Configuration • Network Configuration • Test Network Connectivity • View System Resource Check • System Time Management • License Information • Command Prompt Note Some options appear only for specific gateway types or host platforms. Enter the corresponding numeral to navigate to the Network Configuration page. 4. Do one of the following to configure the gateway IP address: • To use the IP address assigned by your Dynamic Host Configuration Protocol (DHCP) server, enter the corresponding numeral for Configure DHCP, and then enter valid DHCP configuration information on the following page. • To assign a static IP address, enter the corresponding numeral for Configure Static IP, and then enter valid IP address and DNS information on the following page. Note The IP address you specify here must be on the same subnet as the IP address used during hardware appliance activation. To exit the gateway local console Press the Crtl+] (close bracket) keystroke. The hardware console appears. • Configuring a gateway IP address on the hardware appliance API Version 2013-06-30 43 AWS Storage Gateway Note Tape Gateway User Guide The keystroke preceding is the only way to exit the gateway local console. After your hardware appliance has been activated and configured, your appliance appears in the console. Now you can continue the setup and configuration procedure for your gateway in the Storage Gateway console. For instructions, see . Removing gateway software from your hardware appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. If you no longer need a specific Storage Gateway that you have deployed
|
storagegateway-tgw-ug-017
|
storagegateway-tgw-ug.pdf
| 17 |
and configuration procedure for your gateway in the Storage Gateway console. For instructions, see . Removing gateway software from your hardware appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. If you no longer need a specific Storage Gateway that you have deployed on a hardware appliance, you can remove the gateway software from the hardware appliance. After you remove the gateway software, you can choose to deploy a new gateway in its place, or delete the hardware appliance itself from the Storage Gateway console. To remove gateway software from your hardware appliance, use the following procedure. To remove a gateway from a hardware appliance 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. Choose Hardware from the navigation pane on the left side of the console page, and then choose the Hardware appliance name for the appliance from which you want to remove gateway software. 3. From the Actions drop down menu, choose Remove gateway. The confirmation dialog box appears. Removing gateway software from your hardware appliance API Version 2013-06-30 44 AWS Storage Gateway Tape Gateway User Guide 4. Verify that you want to remove the gateway software from the specified hardware appliance, and then type the word remove in the confirmation box. 5. Choose Remove to permanently remove the gateway software. Note After you remove the gateway software, you can't undo the action. For certain gateway types, you can lose data on deletion, particularly cached data. For more information on deleting a gateway, see Deleting your gateway and removing associated resources. Removing the gateway doesn't delete the hardware appliance from the console. The hardware appliance remains for future gateway deployments. Deleting your Storage Gateway Hardware Appliance Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be offered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you can use the AWS Storage Gateway service to give your applications on- premises and in-cloud access to virtually unlimited cloud storage. If you no longer need an Storage Gateway Hardware Appliance that you have already activated, you can delete the appliance completely from your AWS account. Note To move your appliance to a different AWS account or AWS Region, you must first delete it using the following procedure, then open the gateway's support channel and contact Support to perform a soft reset. For more information, see Turning on Support access to help troubleshoot your gateway hosted on-premises. Deleting your hardware appliance API Version 2013-06-30 45 AWS Storage Gateway Tape Gateway User Guide To delete your hardware appliance 1. If you have installed a gateway on the hardware appliance, you must first remove the gateway before you can delete the appliance. For instructions on how to remove a gateway from your hardware appliance, see Removing gateway software from your hardware appliance. 2. On the Hardware page of the Storage Gateway console, choose the hardware appliance you want to delete. 3. For Actions, choose Delete Appliance. The confirmation dialog box appears. 4. Verify that you want to delete the specified hardware appliance, then type the word delete in the confirmation box and choose Delete. When you delete the hardware appliance, all resources associated with the gateway that is installed on the appliance are deleted, but the data on the hardware appliance itself is not deleted. Deleting your hardware appliance API Version 2013-06-30 46 AWS Storage Gateway Tape Gateway User Guide Creating your gateway The overview sections on this page provide a high-level synopsis of how the Storage Gateway creation process works. For step-by-step procedures to create a specific type of gateway using the Storage Gateway console, see the following topics: • Create and activate an Amazon S3 File Gateway • Create and activate an Amazon FSx File Gateway • Create and activate a Tape Gateway • Create and activate a Volume Gateway Important Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post. Overview - Gateway Activation Gateway activation involves setting up your gateway, connecting it to AWS, then reviewing your settings and activating it. Set up gateway To set up your Storage Gateway, you first choose the type of gateway you want to create and the host platform on which you will run the gateway virtual
|
storagegateway-tgw-ug-018
|
storagegateway-tgw-ug.pdf
| 18 |
a Tape Gateway • Create and activate a Volume Gateway Important Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post. Overview - Gateway Activation Gateway activation involves setting up your gateway, connecting it to AWS, then reviewing your settings and activating it. Set up gateway To set up your Storage Gateway, you first choose the type of gateway you want to create and the host platform on which you will run the gateway virtual appliance. You then download the gateway virtual appliance template for the platform of your choice and deploy it in your on-premises environment. You can also deploy your Storage Gateway as a physical hardware appliance that you order from your preferred reseller, or as an Amazon EC2 instance in your AWS cloud environment. When you deploy the gateway appliance, you allocate local physical disk space on the virtualization host. Connect to AWS The next step is to connect your gateway to AWS. To do this, you first choose the type of service endpoint you want to use for communications between the gateway virtual appliance and AWS Overview - Gateway Activation API Version 2013-06-30 47 AWS Storage Gateway Tape Gateway User Guide services in the cloud. This endpoint can be accessible from the public internet, or only from within your Amazon VPC, where you have full control over the network security configuration. You then specify the gateway's IP address or its activation key, which you can obtain by connecting to the local console on the gateway appliance. Review and activate At this point, you'll have an opportunity to review the gateway and connection options you chose, and make changes if necessary. When everything is set up the way you want you can activate the gateway. Before you can start using your activated gateway, you will need to configure some additional settings and create your storage resources. Overview - Gateway Configuration After you activate your Storage Gateway, you need to perform some additional configuration. In this step, you allocate the physical storage you provisioned on the gateway host platform to be used as either the cache or the upload buffer by the gateway appliance. You then configure settings to help monitor the health of your gateway using Amazon CloudWatch Logs and CloudWatch alarms, and add tags to help identify the gateway, if desired. Before you can start using your activated and configured gateway, you will need to create your storage resources. Overview - Storage Resources After you activate and configure your Storage Gateway, you need to create cloud storage resources for it to use. Depending on the type of gateway you created, you will use the Storage Gateway console to create Volumes, Tapes, or Amazon S3 or Amazon FSx files shares to associate with it. Each gateway type uses its respective resources to emulate the related type of network storage infrastructure, and transfers the data you write to it into the AWS cloud. Create and activate a Tape Gateway In this section, you can find instructions on how to download, deploy, and activate a standard Tape Gateway. Topics • Set up a Tape Gateway Review and activate API Version 2013-06-30 48 AWS Storage Gateway Tape Gateway User Guide • Connect your Tape Gateway to AWS • Review settings and activate your Tape Gateway • Configure your Tape Gateway Set up a Tape Gateway To set up a new Tape Gateway 1. Open the AWS Management Console at https://console.aws.amazon.com/storagegateway/ home/, and choose the AWS Region where you want to create your gateway. 2. Choose Create gateway to open the Set up gateway page. 3. In the Gateway settings section, do the following: a. b. For Gateway name, enter a name for your gateway. You can search for this name to find your gateway on list pages in the Storage Gateway console. For Gateway time zone, choose the local time zone for the part of the world where you want to deploy your gateway. 4. 5. In the Gateway options section, for Gateway type, choose Tape Gateway. In the Platform options section, do the following: a. For Host platform, choose the platform on which you want to deploy your gateway, then follow the platform-specific instructions displayed on the Storage Gateway console page to set up your host platform. You can choose from the following options: • VMware ESXi - Download, deploy, and configure the gateway virtual machine using VMware ESXi. • Microsoft Hyper-V - Download, deploy, and configure the gateway virtual machine using Microsoft Hyper-V. • Linux KVM - Download, deploy, and configure the gateway virtual machine using Linux KVM. • Amazon EC2 - Configure and launch an Amazon EC2 instance to host your gateway.
|
storagegateway-tgw-ug-019
|
storagegateway-tgw-ug.pdf
| 19 |
a. For Host platform, choose the platform on which you want to deploy your gateway, then follow the platform-specific instructions displayed on the Storage Gateway console page to set up your host platform. You can choose from the following options: • VMware ESXi - Download, deploy, and configure the gateway virtual machine using VMware ESXi. • Microsoft Hyper-V - Download, deploy, and configure the gateway virtual machine using Microsoft Hyper-V. • Linux KVM - Download, deploy, and configure the gateway virtual machine using Linux KVM. • Amazon EC2 - Configure and launch an Amazon EC2 instance to host your gateway. This option is not available for Stored volume gateways. • Hardware appliance - Order a dedicated physical hardware appliance from AWS to host your gateway. Set up a Tape Gateway API Version 2013-06-30 49 AWS Storage Gateway Tape Gateway User Guide b. For Confirm set up gateway, select the check box to confirm that you performed the deployment steps for the host platform you chose. This step is not applicable for the Hardware appliance host platform. 6. In the Backup application settings section, for Backup application, choose the application you want to use to backup your tape data to the virtual tapes associated with your Tape Gateway. 7. Choose Next to proceed. Now that your gateway is set up, you need to choose how you want it to connect and communicate with AWS. For instructions, see Connect your Tape Gateway to AWS. Connect your Tape Gateway to AWS To connect a new Tape Gateway to AWS 1. Complete the procedure described in Set up a Tape Gateway if you have not done so already. When finished, choose Next to open the Connect to AWS page in the Storage Gateway console. 2. In the Endpoint options section, for Service endpoint, choose the type of endpoint your gateway will use to communicate with AWS. You can choose from the following options: • Publicly accessible - Your gateway communicates with AWS over the public internet. If you select this option, use the FIPS enabled endpoint check box to specify whether the connection should comply with Federal Information Processing Standards (FIPS). Note If you require FIPS 140-2 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS-compliant endpoint. For more information, see Federal Information Processing Standard (FIPS) 140-2. The FIPS service endpoint is only available in some AWS Regions. For more information, see Storage Gateway endpoints and quotas in the AWS General Reference. • VPC hosted - Your gateway communicates with AWS through a private connection with your VPC, allowing you to control your network settings. If you select this option, you must specify an existing VPC endpoint by choosing its VPC endpoint ID from the drop-down Connect your Tape Gateway to AWS API Version 2013-06-30 50 AWS Storage Gateway Tape Gateway User Guide menu, or by providing its VPC endpoint DNS name or IP address. For more information, see Activating your gateway in a virtual private cloud. 3. In the Gateway connection options section, for Connection options, choose how to identify your gateway to AWS. You can choose from the following options: • IP address - Provide the IP address of your gateway in the corresponding field. This IP address must be public or accessible from within your current network, and you must be able to connect to it from your web browser. You can obtain the gateway IP address by logging into the gateway's local console from your hypervisor client, or by copying it from your Amazon EC2 instance details page. • Activation key - Provide the activation key for your gateway in the corresponding field. You can generate an activation key using the gateway's local console. Choose this option if your gateway's IP address is unavailable. 4. Choose Next to proceed. Now that you have chosen how you want your gateway to connect to AWS, you need to activate the gateway. For instructions, see Review settings and activate your Tape Gateway. Review settings and activate your Tape Gateway To activate a new Tape Gateway 1. Complete the procedures described in the following topics if you have not done so already: • Set up a Tape Gateway • Connect your Tape Gateway to AWS When finished, choose Next to open the Review and activate page in the Storage Gateway console. 2. Review the initial gateway details for each section on the page. 3. If a section contains errors, choose Edit to return to the corresponding settings page and make changes. Review settings and activate your Tape Gateway API Version 2013-06-30 51 AWS Storage Gateway Note Tape Gateway User Guide You cannot modify the gateway options or connection settings after your gateway is activated. 4. Choose Activate gateway to proceed. Now that you have activated your
|
storagegateway-tgw-ug-020
|
storagegateway-tgw-ug.pdf
| 20 |
Tape Gateway • Connect your Tape Gateway to AWS When finished, choose Next to open the Review and activate page in the Storage Gateway console. 2. Review the initial gateway details for each section on the page. 3. If a section contains errors, choose Edit to return to the corresponding settings page and make changes. Review settings and activate your Tape Gateway API Version 2013-06-30 51 AWS Storage Gateway Note Tape Gateway User Guide You cannot modify the gateway options or connection settings after your gateway is activated. 4. Choose Activate gateway to proceed. Now that you have activated your gateway, you need to perform first-time configuration to allocate local storage disks and configure logging. For instructions, see Configure your Tape Gateway. Configure your Tape Gateway To perform first-time configuration on a new Tape Gateway 1. Complete the procedures described in the following topics if you have not done so already: • Set up a Tape Gateway • Connect your Tape Gateway to AWS • Review settings and activate your Tape Gateway When finished, choose Next to open the Configure gateway page in the Storage Gateway console. 2. In the Configure storage section, use the drop-down menus to allocate at least one disk with at least 165 GiB capacity for CACHE STORAGE, and at least one disk with at least 150 GiB capacity for UPLOAD BUFFER. The local disks listed in this section correspond to the physical storage that you provisioned on your host platform. 3. In the CloudWatch log group section, choose how to set up Amazon CloudWatch Logs to monitor the health of your gateway. You can choose from the following options: • Create a new log group - Set up a new log group to monitor your gateway. • Use an existing log group - Choose an existing log group from the corresponding drop- down menu. • Deactivate logging - Do not use Amazon CloudWatch Logs to monitor your gateway. Configure your Tape Gateway API Version 2013-06-30 52 AWS Storage Gateway Note Tape Gateway User Guide To receive Storage Gateway health logs, the following permissions must be present in your log group resource policy. Replace the highlighted section with the specific log group resourceArn information for your deployment. "Sid": "AWSLogDeliveryWrite20150319", "Effect": "Allow", "Principal": { "Service": [ "delivery.logs.amazonaws.com" ] }, "Action": [ "logs:CreateLogStream", "logs:PutLogEvents" ], "Resource": "arn:aws:logs:eu-west-1:1234567890:log-group:/foo/bar:log- stream:*" The "Resource" element is required only if you want the permissions to apply explicitly to an individual log group. 4. In the CloudWatch alarms section, choose how to set up Amazon CloudWatch alarms to notify you when gateway metrics deviate from defined limits. You can choose from the following options: • Create Storage Gateway's recommended alarms – Create all recommended CloudWatch alarms automatically when the gateway is created. For more information about recommended alarms, see Understanding CloudWatch alarms. Note This feature requires CloudWatch policy permissions, which are not automatically granted as part of the preconfigured Storage Gateway full access policy. Make sure your security policy grants the following permissions before you attempt to create recommended CloudWatch alarms: • cloudwatch:PutMetricAlarm - create alarms Configure your Tape Gateway API Version 2013-06-30 53 AWS Storage Gateway Tape Gateway User Guide • cloudwatch:DisableAlarmActions - turn alarm actions off • cloudwatch:EnableAlarmActions - turn alarm actions on • cloudwatch:DeleteAlarms - delete alarms • Create a custom alarm – Configure a new CloudWatch alarm to notify you about your gateway's metrics. Choose Create alarm to define metrics and specify alarm actions in the Amazon CloudWatch console. For instructions, see Using Amazon CloudWatch alarms in the Amazon CloudWatch User Guide. • No alarm – Don't receive CloudWatch notifications about your gateway's metrics. 5. (Optional) In the Tags section, choose Add new tag, then enter a case-sensitive key-value pair to help you search and filter for your gateway on list pages in the Storage Gateway console. Repeat this step to add as many tags as you need. 6. Choose Configure to finish creating your gateway. To check the status of your new gateway, search for it on the Gateway overview page of the Storage Gateway. Now that you have created your gateway, you need to create virtual tapes for it to use. For instructions, see Creating Tapes. Creating new virtual tapes for Tape Gateway This section describes how to create new virtual tapes using AWS Storage Gateway. You can create new virtual tapes manually using either the AWS Storage Gateway console or the Storage Gateway API. You can also configure your Tape Gateway to create them automatically, which helps decrease the need for manual tape management, makes your large deployments simpler, and helps scale on-premises and archive storage needs. Tape Gateway supports write once, read many (WORM) and tape retention lock on virtual tapes. WORM-activated virtual tapes help ensure that the data on active tapes in your virtual tape
|
storagegateway-tgw-ug-021
|
storagegateway-tgw-ug.pdf
| 21 |
virtual tapes for Tape Gateway This section describes how to create new virtual tapes using AWS Storage Gateway. You can create new virtual tapes manually using either the AWS Storage Gateway console or the Storage Gateway API. You can also configure your Tape Gateway to create them automatically, which helps decrease the need for manual tape management, makes your large deployments simpler, and helps scale on-premises and archive storage needs. Tape Gateway supports write once, read many (WORM) and tape retention lock on virtual tapes. WORM-activated virtual tapes help ensure that the data on active tapes in your virtual tape library cannot be overwritten or erased. For more information about WORM protection for virtual tapes, see the section following, the section called “WORM Tape Protection”. With tape retention lock, you can specify the retention mode and period on archived virtual tapes, preventing them from being deleted for a fixed amount of time up to 100 years. It Creating Tapes API Version 2013-06-30 54 AWS Storage Gateway Tape Gateway User Guide includes permission controls on who can delete tapes or modify the retention settings. For more information about tape retention lock, see the section called “Tape Retention Lock”. Note You are charged only for the amount of data that you write to the tape, not the tape capacity. You can use AWS Key Management Service (AWS KMS) to encrypt data written to a virtual tape that is stored in Amazon Simple Storage Service (Amazon S3). Currently, you can do this by using the AWS Storage Gateway API or AWS Command Line Interface (AWS CLI). For more information, see CreateTapes or create-tapes. Write Once, Read Many (WORM) Tape Protection You can prevent virtual tapes from being overwritten or erased by activating WORM protection for virtual tapes in AWS Storage Gateway. WORM protection for virtual tapes is activated when creating tapes. Data that is written to WORM virtual tapes can't be overwritten. Only new data can be appended to WORM virtual tapes, and existing data can't be erased. Activating WORM protection for virtual tapes helps protect those tapes while they are in active use, before they are ejected and archived. WORM configuration can only be set when tapes are created, and that configuration cannot be changed after the tapes are created. Creating Tapes Manually You can create new virtual tapes manually using either the AWS Storage Gateway console or the Storage Gateway API. The console offers a convenient interface for tape creation with the flexibility to specify a prefix for a randomly-generated tape barcode. If you need to fully customize your tape barcodes (for example, to match the serial number of a corresponding physical tape), you must use the API. For more information on creating tapes using the Storage Gateway API. see CreateTapeWithBarcode in the Storage Gateway API Reference. To create virtual tapes manually using the Storage Gateway console 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. WORM Tape Protection API Version 2013-06-30 55 AWS Storage Gateway Tape Gateway User Guide 2. In the navigation pane, choose the Gateways tab. 3. Choose Create tapes to open the Create tapes pane. 4. 5. 6. 7. 8. For Gateway, choose a gateway. The tape is created for this gateway. For Tape type, choose Standard to create standard virtual tapes. Choose WORM to create write once read many (WORM) virtual tapes. For more information, see Write Once, Read Many (WORM) Tape Protection . For Number of tapes, choose the number of tapes that you want to create. For more information about tape quotas, see AWS Storage Gateway quotas. For Capacity, enter the size of the virtual tape that you want to create. Tapes must be larger than 100 GiB. For information about capacity quotas, see AWS Storage Gateway quotas. For Barcode prefix, enter the prefix that you want to prepend to the barcode of your virtual tapes. Note Virtual tapes are uniquely identified by a barcode, and you can add a prefix to the barcode. You can use a prefix to help identify your virtual tapes. The prefix must be uppercase letters (A–Z) and must be one to four characters long. 9. For Pool, choose Glacier Pool, Deep Archive Pool, or a custom pool that you have created. The pool determines the storage class in which your tape is stored when it is ejected by your backup software. • Choose Glacier Pool if you want to archive the tape in the S3 Glacier Flexible Retrieval storage class. When your backup software ejects the tape, it is automatically archived in S3 Glacier Flexible Retrieval. You use S3 Glacier Flexible Retrieval for more active archives, where you can retrieve a tape typically within 3-5 hours. For more information, see Storage classes for archiving objects in the Amazon Simple Storage Service User Guide. • Choose Deep Archive Pool
|
storagegateway-tgw-ug-022
|
storagegateway-tgw-ug.pdf
| 22 |
you have created. The pool determines the storage class in which your tape is stored when it is ejected by your backup software. • Choose Glacier Pool if you want to archive the tape in the S3 Glacier Flexible Retrieval storage class. When your backup software ejects the tape, it is automatically archived in S3 Glacier Flexible Retrieval. You use S3 Glacier Flexible Retrieval for more active archives, where you can retrieve a tape typically within 3-5 hours. For more information, see Storage classes for archiving objects in the Amazon Simple Storage Service User Guide. • Choose Deep Archive Pool if you want to archive the tape in the S3 Glacier Deep Archive storage class. When your backup software ejects the tape, the tape is automatically archived in S3 Glacier Deep Archive. You use S3 Glacier Deep Archive for long-term data retention and digital preservation, where data is accessed once or twice a year. You can retrieve a tape archived in S3 Glacier Deep Archive typically within 12 hours. For more information, see Storage classes for archiving objects in the Amazon Simple Storage Service User Guide. Creating Tapes Manually API Version 2013-06-30 56 AWS Storage Gateway Tape Gateway User Guide • Choose a custom pool, if any are available. You configure custom tape pools to use either Deep Archive Pool or Glacier Pool. Tapes are archived to the configured storage class when they are ejected by your backup software. If you archive a tape in S3 Glacier Flexible Retrieval, you can move it to S3 Glacier Deep Archive later. For more information, see Moving tapes to S3 Glacier Deep Archive storage class. Note Tapes created before March 27, 2019, are archived directly in S3 Glacier Flexible Retrieval when your backup software ejects them. 10. (Optional) For Tags, choose Add new tag and enter a key and value to add tags to your tape. A tag is a case-sensitive key-value pair that helps you manage, filter, and search for your tapes. 11. Choose Create tapes. 12. In the navigation pane, choose Tape Library > Tapes to see your tapes. By default, this list displays up to 1,000 tapes at a time, but the searches that you perform apply to all of your tapes. You can use the search bar to find tapes that match a specific criteria, or to reduce the list to less than 1,000 tapes. When your list contains 1,000 tapes or fewer, you can then sort your tapes in ascending or descending order by various properties. The status of the virtual tapes is initially set to CREATING when the virtual tapes are being created. After the tapes are created, their status changes to AVAILABLE. For more information, see Understanding Tape Status. Allowing Automatic Tape Creation The Tape Gateway can automatically create new virtual tapes to maintain the minimum number of available tapes that you configure. It then makes these new tapes available for import by the backup application so that your backup jobs can run without interruption. Allowing automatic tape creation removes the need for custom scripting in addition to the manual process of creating new virtual tapes. The Tape Gateway spawns a new tape automatically when it has fewer tapes than the minimum number of available tapes specified for automatic tape creation. A new tape is spawned when: • A tape is imported from an import/export slot. Allowing Automatic Tape Creation API Version 2013-06-30 57 AWS Storage Gateway Tape Gateway User Guide • A tape is imported to the tape drive. The gateway maintains a minimum number of tapes with the barcode prefix specified in the automatic tape creation policy. If there are fewer tapes than the minimum number of tapes with the barcode prefix, the gateway automatically creates enough new tapes to equal the minimum number of tapes specified in the automatic tape creation policy. When you eject a tape and it goes into the import/export slot, that tape does not count toward the minimum number of tapes specified in your automatic tape creation policy. Only tapes in the import/export slot are counted as being "available." Exporting a tape does not initiate automatic tape creation. Only imports affect the number of available tapes. Moving a tape from the import/export slot to a tape drive or storage slot reduces the number of tapes in the import/export slot with the same barcode prefix. The gateway creates new tapes to maintain the minimum number of available tapes for that barcode prefix. To allow automatic tape creation 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. In the navigation pane, choose the Gateways tab. 3. Choose the gateway that you want to automatically create tapes for. 4. In the Actions menu, choose Configure tape auto-create. The Tape auto-create page appears. You can add, change, or remove tape auto-create options
|
storagegateway-tgw-ug-023
|
storagegateway-tgw-ug.pdf
| 23 |
from the import/export slot to a tape drive or storage slot reduces the number of tapes in the import/export slot with the same barcode prefix. The gateway creates new tapes to maintain the minimum number of available tapes for that barcode prefix. To allow automatic tape creation 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. In the navigation pane, choose the Gateways tab. 3. Choose the gateway that you want to automatically create tapes for. 4. In the Actions menu, choose Configure tape auto-create. The Tape auto-create page appears. You can add, change, or remove tape auto-create options here. To allow automatic tape creation, choose Add new item then configure the settings for automatic tape creation. For Tape type, choose Standard to create standard virtual tapes. Choose WORM to create write-once-read-many (WORM) virtual tapes. For more information, see Write Once, Read Many (WORM) Tape Protection . For Minimum number of tapes, enter the minimum number of virtual tapes that should be available on the Tape Gateway at all times. The valid range for this value is a minimum of 1 and a maximum of 10. For Capacity, enter the size, in bytes, of the virtual tape capacity. The valid range is a minimum of 100 GiB and a maximum of 15 TiB. 5. 6. 7. 8. Allowing Automatic Tape Creation API Version 2013-06-30 58 AWS Storage Gateway Tape Gateway User Guide 9. For Barcode prefix, enter the prefix that you want to prepend to the barcode of your virtual tapes. Note Virtual tapes are uniquely identified by a barcode, and you can add a prefix to the barcode. The prefix is optional, but you can use it to help identify your virtual tapes. The prefix must be uppercase letters (A–Z) and must be one to four characters long. 10. For Pool, choose Glacier Pool, Deep Archive Pool, or a custom pool that you have created. The pool determines the storage class in which your tape is stored when it is ejected by your backup software. • Choose Glacier Pool if you want to archive the tape in the S3 Glacier Flexible Retrieval storage class. When your backup software ejects the tape, it is automatically archived in S3 Glacier Flexible Retrieval. You use S3 Glacier Flexible Retrieval for more active archives, where you can retrieve a tape typically within 3-5 hours. For more information, see Storage classes for archiving objects in the Amazon Simple Storage Service User Guide. • Choose Deep Archive Pool if you want to archive the tape in the S3 Glacier Deep Archive storage class. When your backup software ejects the tape, the tape is automatically archived in S3 Glacier Deep Archive. You use S3 Glacier Deep Archive for long-term data retention and digital preservation, where data is accessed once or twice a year. You can retrieve a tape archived in S3 Glacier Deep Archive typically within 12 hours. For more information, see Storage classes for archiving objects in the Amazon Simple Storage Service User Guide. • Choose a custom pool, if any are available. You configure custom tape pools to use either Deep Archive Pool or Glacier Pool. Tapes are archived to the configured storage class when they are ejected by your backup software. If you archive a tape in S3 Glacier Flexible Retrieval, you can move it to S3 Glacier Deep Archive later. For more information, see Moving tapes to S3 Glacier Deep Archive storage class. Note Tapes created before March 27, 2019, are archived directly in S3 Glacier Flexible Retrieval when your backup software ejects them. 11. When finished configuring settings, choose Save changes. Allowing Automatic Tape Creation API Version 2013-06-30 59 AWS Storage Gateway Tape Gateway User Guide 12. In the navigation pane, choose Tape Library > Tapes to see your tapes. By default, this list displays up to 1,000 tapes at a time, but the searches that you perform apply to all of your tapes. You can use the search bar to find tapes that match a specific criteria, or to reduce the list to less than 1,000 tapes. When your list contains 1,000 tapes or fewer, you can then sort your tapes in ascending or descending order by various properties. The status of available virtual tapes is initially set to CREATING when the tapes are being created. After the tapes are created, their status changes to AVAILABLE. For more information, see Understanding Tape Status. For more information about changing automatic tape creation policies, or deleting automatic tape creation from a Tape Gateway, see Managing Automatic Tape Creation. Next Step Using Your Tape Gateway Creating a Custom Tape Pool This section describes how to create a new custom tape pool in AWS Storage Gateway. Topics • Choosing a Tape Pool Type • Using Tape Retention Lock • Creating a Custom Tape
|
storagegateway-tgw-ug-024
|
storagegateway-tgw-ug.pdf
| 24 |
The status of available virtual tapes is initially set to CREATING when the tapes are being created. After the tapes are created, their status changes to AVAILABLE. For more information, see Understanding Tape Status. For more information about changing automatic tape creation policies, or deleting automatic tape creation from a Tape Gateway, see Managing Automatic Tape Creation. Next Step Using Your Tape Gateway Creating a Custom Tape Pool This section describes how to create a new custom tape pool in AWS Storage Gateway. Topics • Choosing a Tape Pool Type • Using Tape Retention Lock • Creating a Custom Tape Pool Choosing a Tape Pool Type AWS Storage Gateway uses tape pools to determine the storage class that you want tapes to be archived in when they are ejected. Storage Gateway provides two standard tape pools: • Glacier Pool – Archives the tape in the S3 Glacier Flexible Retrieval storage class. When your backup software ejects the tape, it is automatically archived in S3 Glacier Flexible Retrieval. You use S3 Glacier Flexible Retrieval for more active archives, where you can retrieve the tapes typically within 3-5 hours. For more information, see Storage classes for archiving objects in the Amazon Simple Storage Service User Guide. Creating Custom Tape Pools API Version 2013-06-30 60 AWS Storage Gateway Tape Gateway User Guide • Deep Archive Pool – Archives the tape in the S3 Glacier Deep Archive storage class. When your backup software ejects the tape, the tape is automatically archived in S3 Glacier Deep Archive. You use S3 Glacier Deep Archive for long-term data retention and digital preservation, where data is accessed once or twice a year. You can retrieve tapes archived in S3 Glacier Deep Archive typically within 12 hours. For detailed information, see Storage classes for archiving objects in the Amazon Simple Storage Service User Guide. If you archive a tape in S3 Glacier Flexible Retrieval, you can move it to S3 Glacier Deep Archive later. For more information, see Moving tapes to S3 Glacier Deep Archive storage class. Storage Gateway also supports creation of custom tape pools, which allow you to activate tape retention lock to prevent archived tapes from being deleted or moved to another pool for a fixed amount of time, up to 100 years. This includes locking permission controls on who can delete tapes or modify retention settings. Using Tape Retention Lock With tape retention lock, you can lock archived tapes. Tape retention lock is an option for tapes in a custom tape pool. Tapes that have tape retention lock activated can't be deleted or moved to another pool for a fixed amount of time, up to 100 years. You can configure tape retention lock in one of two modes: • Governance mode – When configured in governance mode, only AWS Identity and Access Management (IAM) users with the permissions to perform storagegateway:BypassGovernanceRetention can remove tapes from the pool. If you're using the AWS Storage Gateway API to remove the tape, you must also set BypassGovernanceRetention to true. • Compliance mode – When configured in compliance mode, the protection cannot be removed by any user, including the root AWS account. When a tape is locked in compliance mode, its retention lock type can't be changed, and its retention period can't be shortened. The compliance mode lock type helps ensure that a tape can't be overwritten or deleted for the duration of the retention period. Tape Retention Lock API Version 2013-06-30 61 AWS Storage Gateway Important A custom pool’s configuration cannot be changed after it is created. Tape Gateway User Guide You can activate tape retention lock when you create a custom tape pool. Any new tapes that are attached to a custom pool inherit the retention lock type, period, and storage class for that pool. You can also activate tape retention lock on tapes that were archived before the release of this feature by moving tapes between the default pool and a custom pool that you create. If the tape is archived, the tape retention lock is effective immediately. Note If you're moving archived tapes between the S3 Glacier Flexible Retrieval and S3 Glacier Deep Archive storage classes, you are charged a fee for moving a tape. There is no additional charge to move a tape from a default pool to a custom pool if the storage class remains the same. Creating a Custom Tape Pool Use the following steps to create a custom tape pool using the AWS Storage Gateway console. To create a custom tape pool 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. In the left navigation pane, choose the Tape Library tab, and then choose the Pools tab. 3. Choose Create pool to open the Create pool pane. 4. 5. 6. For Name, enter a unique name to identify your custom
|
storagegateway-tgw-ug-025
|
storagegateway-tgw-ug.pdf
| 25 |
There is no additional charge to move a tape from a default pool to a custom pool if the storage class remains the same. Creating a Custom Tape Pool Use the following steps to create a custom tape pool using the AWS Storage Gateway console. To create a custom tape pool 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. In the left navigation pane, choose the Tape Library tab, and then choose the Pools tab. 3. Choose Create pool to open the Create pool pane. 4. 5. 6. For Name, enter a unique name to identify your custom tape pool. The pool name must be between 2 and 100 characters long. For Storage class, choose Glacier or Glacier Deep Archive. For Retention lock type, choose None, Compliance, or Governance. Creating a Custom Tape Pool API Version 2013-06-30 62 AWS Storage Gateway Note Tape Gateway User Guide If you choose Compliance, tape retention lock cannot be removed by any user, including the root AWS account. 7. 8. If you choose a tape retention lock type, enter the Retention period in days. The maximum retention period is 36,500 days (100 years). (Optional) For Tags, choose Add new tag to add a tag to your custom tape pool. A tag is a case-sensitive key-value pair that helps you manage, filter, and search for your custom tape pools. Enter a Key, and optionally, a Value for your tag. You can add up to 50 tags to the tape pool. 9. Choose Create pool to create your new custom tape pool. Connecting your VTL devices Following, you can find instructions about how to connect your virtual tape library (VTL) devices to your Microsoft Windows or Red Hat Enterprise Linux (RHEL) client. Topics • Connecting to a Microsoft Windows Client • Connecting to a Linux Client Connecting to a Microsoft Windows Client The following procedure shows a summary of the steps that you follow to connect to a Windows client. To connect your VTL devices to a Windows client 1. Start iscsicpl.exe. Note You must have administrator rights on the client computer to run the iSCSI initiator. Connecting Your VTL Devices API Version 2013-06-30 63 AWS Storage Gateway Tape Gateway User Guide 2. 3. Start the Microsoft iSCSI initiator service. In the iSCSI Initiator Properties dialog box, choose the Discovery tab, and then choose Discover Portal. 4. Provide the IP address of your Tape Gateway for IP address or DNS name. 5. Choose the Targets tab, and then choose Refresh. All 10 tape drives and the medium changer appear in the Discovered targets box. The status for the targets is Inactive. 6. Choose the first device and connect it. You connect the devices one at a time. 7. Connect all of the targets. On a Windows client, the driver provider for the tape drive must be Microsoft. Use the following procedure to verify the driver provider, and update the driver and provider if necessary: To verify and update the driver and provider 1. On your Windows client, start Device Manager. 2. 3. 4. Expand Tape drives, open the context (right-click) menu for a tape drive, and choose Properties. In the Driver tab of the Device Properties dialog box, verify Driver Provider is Microsoft. If Driver Provider is not Microsoft, set the value as follows: a. b. c. Choose Update Driver. In the Update Driver Software dialog box, choose Browse my computer for driver software. In the Update Driver Software dialog box, choose Let me pick from a list of device drivers on my computer. d. Choose LTO Tape drive and choose Next. 5. Choose Close to close the Update Driver Software window, and verify that the Driver Provider value is now set to Microsoft. 6. Repeat the steps to update driver and provider for all the tape drives. Connecting to a Linux Client The following procedure shows a summary of the steps that you follow to connect to an RHEL client. Connecting to a Linux Client API Version 2013-06-30 64 AWS Storage Gateway Tape Gateway User Guide To connect a Linux client to VTL devices 1. Install the iscsi-initiator-utils RPM package. You can use the following command to install the package. sudo yum install iscsi-initiator-utils 2. Make sure that the iSCSI daemon is running. For RHEL 8 or 9, use the following command. sudo service iscsid status 3. Discover the volume or VTL device targets defined for a gateway. Use the following discovery command. sudo /sbin/iscsiadm --mode discovery --type sendtargets --portal [GATEWAY_IP]:3260 The output of the discovery command looks like the following example output. For Volume Gateways: [GATEWAY_IP]:3260, 1 iqn.1997-05.com.amazon:myvolume For Tape Gateways: iqn.1997-05.com.amazon:[GATEWAY_IP]-tapedrive-01 4. Connect to a target. Be sure to specify the correct [GATEWAY_IP] and IQN in the connect command. Use the following command. sudo /sbin/iscsiadm --mode node --targetname iqn.1997-05.com.amazon:[ISCSI_TARGET_NAME] --portal [GATEWAY_IP]:3260,1
|
storagegateway-tgw-ug-026
|
storagegateway-tgw-ug.pdf
| 26 |
iscsi-initiator-utils 2. Make sure that the iSCSI daemon is running. For RHEL 8 or 9, use the following command. sudo service iscsid status 3. Discover the volume or VTL device targets defined for a gateway. Use the following discovery command. sudo /sbin/iscsiadm --mode discovery --type sendtargets --portal [GATEWAY_IP]:3260 The output of the discovery command looks like the following example output. For Volume Gateways: [GATEWAY_IP]:3260, 1 iqn.1997-05.com.amazon:myvolume For Tape Gateways: iqn.1997-05.com.amazon:[GATEWAY_IP]-tapedrive-01 4. Connect to a target. Be sure to specify the correct [GATEWAY_IP] and IQN in the connect command. Use the following command. sudo /sbin/iscsiadm --mode node --targetname iqn.1997-05.com.amazon:[ISCSI_TARGET_NAME] --portal [GATEWAY_IP]:3260,1 --login 5. Verify that the volume is attached to the client machine (the initiator). To do so, use the following command. ls -l /dev/disk/by-path The output of the command should look like the following example output. Connecting to a Linux Client API Version 2013-06-30 65 AWS Storage Gateway Tape Gateway User Guide lrwxrwxrwx. 1 root root 9 Apr 16 19:31 ip-[GATEWAY_IP]:3260-iscsi- iqn.1997-05.com.amazon:myvolume-lun-0 -> ../../sda For Volume Gateways, we highly recommend that after you set up your initiator, you customize your iSCSI settings as discussed in Customizing Your Linux iSCSI Settings. Verify that the VTL device is attached to the client machine (the initiator). To do so, use the following command. ls -l /dev/tape/by-path The output of the command should look like the following example output. total 0 lrwxrwxrwx 1 root root 10 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-mediachanger-lun-0-changer -> ../../sg20 lrwxrwxrwx 1 root root 9 Sep 8 11:19 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-01-lun-0 -> ../../st6 lrwxrwxrwx 1 root root 10 Sep 8 11:19 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-01-lun-0-nst -> ../../nst6 lrwxrwxrwx 1 root root 9 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-02-lun-0 -> ../../st7 lrwxrwxrwx 1 root root 10 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-02-lun-0-nst -> ../../nst7 lrwxrwxrwx 1 root root 9 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-03-lun-0 -> ../../st8 lrwxrwxrwx 1 root root 10 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-03-lun-0-nst -> ../../nst8 lrwxrwxrwx 1 root root 9 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-04-lun-0 -> ../../st9 lrwxrwxrwx 1 root root 10 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-04-lun-0-nst -> ../../nst9 lrwxrwxrwx 1 root root 10 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-05-lun-0 -> ../../st10 lrwxrwxrwx 1 root root 11 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-05-lun-0-nst -> ../../nst10 lrwxrwxrwx 1 root root 10 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-06-lun-0 -> ../../st11 lrwxrwxrwx 1 root root 11 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-06-lun-0-nst -> ../../nst11 Connecting to a Linux Client API Version 2013-06-30 66 AWS Storage Gateway Tape Gateway User Guide lrwxrwxrwx 1 root root 10 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-07-lun-0 -> ../../st12 lrwxrwxrwx 1 root root 11 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-07-lun-0-nst -> ../../nst12 lrwxrwxrwx 1 root root 10 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-08-lun-0 -> ../../st13 lrwxrwxrwx 1 root root 11 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-08-lun-0-nst -> ../../nst13 lrwxrwxrwx 1 root root 10 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-09-lun-0 -> ../../st14 lrwxrwxrwx 1 root root 11 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-09-lun-0-nst -> ../../nst14 lrwxrwxrwx 1 root root 10 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-10-lun-0 -> ../../st15 lrwxrwxrwx 1 root root 11 Sep 8 11:20 ip-10.6.56.90:3260-iscsi- iqn.1997-05.com.amazon:sgw-9999999c-tapedrive-10-lun-0-nst -> ../../nst15 lrwxrwxrwx 1 root root 9 Aug 19 10:15 pci-0000:12:00.0-fc-0x0000000000000012-lun-0- changer -> ../../sg6 lrwxrwxrwx 1 root root 9 Aug 19 10:15 pci-0000:12:00.0-fc-0x000000000000001c-lun-0 -> ../../st0 lrwxrwxrwx 1 root root 10 Aug 19 10:15 pci-0000:12:00.0-fc-0x000000000000001c- lun-0-nst -> ../../nst0 lrwxrwxrwx 1 root root 9 Aug 19 10:15 pci-0000:12:00.0-fc-0x000000000000001f-lun-0 -> ../../st1 lrwxrwxrwx 1 root root 10 Aug 19 10:15 pci-0000:12:00.0-fc-0x000000000000001f- lun-0-nst -> ../../nst1 lrwxrwxrwx 1 root root 9 Aug 19 10:15 pci-0000:12:00.0-fc-0x0000000000000022-lun-0 -> ../../st2 lrwxrwxrwx 1 root root 10 Aug 19 10:15 pci-0000:12:00.0-fc-0x0000000000000022- lun-0-nst -> ../../nst2 lrwxrwxrwx 1 root root 9 Aug 19 10:15 pci-0000:12:00.1-fc-0x0000000000000025-lun-0 -> ../../st5 lrwxrwxrwx 1 root root 10 Aug 19 10:15 pci-0000:12:00.1-fc-0x0000000000000025- lun-0-nst -> ../../nst5 lrwxrwxrwx 1 root root 9 Aug 19 10:15 pci-0000:12:00.1-fc-0x0000000000000028-lun-0 -> ../../st3 lrwxrwxrwx 1 root root 10 Aug 19 10:15 pci-0000:12:00.1-fc-0x0000000000000028- lun-0-nst -> ../../nst3 lrwxrwxrwx 1 root root 9 Aug 19 10:15 pci-0000:12:00.1-fc-0x000000000000002b-lun-0 -> ../../st4 lrwxrwxrwx 1 root root 10 Aug 19 10:15 pci-0000:12:00.1-fc-0x000000000000002b- lun-0-nst -> ../../nst4 Connecting to a Linux Client API Version 2013-06-30 67 AWS Storage Gateway Next Step Using Your Backup Software to Test Your Gateway Setup Tape Gateway User Guide Using your backup software to test your gateway setup You test your Tape Gateway setup by performing the following tasks using your backup application: 1. Configure the backup application to detect your storage devices. Note To improve I/O performance, we recommend setting the block size of the tape drives in your backup application to 1 MB For more information, see Use a Larger Block Size for Tape Drives. 2. Back up data to a tape. 3. Archive the tape. 4. Retrieve the tape from the archive. 5. Restore data from the tape. To test your setup, use a compatible backup application, as described following. Note Unless otherwise stated, all backup applications were qualified on Microsoft Windows. For more information about compatible backup applications, see Supported third-party backup applications
|
storagegateway-tgw-ug-027
|
storagegateway-tgw-ug.pdf
| 27 |
application to detect your storage devices. Note To improve I/O performance, we recommend setting the block size of the tape drives in your backup application to 1 MB For more information, see Use a Larger Block Size for Tape Drives. 2. Back up data to a tape. 3. Archive the tape. 4. Retrieve the tape from the archive. 5. Restore data from the tape. To test your setup, use a compatible backup application, as described following. Note Unless otherwise stated, all backup applications were qualified on Microsoft Windows. For more information about compatible backup applications, see Supported third-party backup applications for a Tape Gateway. Topics • Testing your setup by using Arcserve Backup • Testing Your Setup by Using Bacula Enterprise • Testing Your Setup by Using Commvault Testing Your Gateway API Version 2013-06-30 68 AWS Storage Gateway Tape Gateway User Guide • Testing Your Setup by Using Dell EMC NetWorker • Testing Your Setup by Using IBM Data Protect • Testing your setup by using OpenText Data Protector • Testing your setup by using Microsoft System Center DPM • Testing your setup by using NovaStor DataCenter • Testing your setup by using Quest NetVault Backup • Testing your setup by using Veeam Backup and Replication • Testing Your Setup by Using Veritas Backup Exec • Testing Your Setup by Using Veritas NetBackup Testing your setup by using Arcserve Backup You can back up your data to virtual tapes, archive the tapes, and manage your virtual tape library (VTL) devices by using Arcserve Backup. In this topic, you can find basic documentation to configure Arcserve Backup with a Tape Gateway and perform a backup and restore operation. For detailed information about to use Arcserve Backup, refer to the Arcserve Backup documentation. Topics • Configuring Arcserve to Work with VTL Devices • Loading Tapes into a Media Pool • Backing Up Data to a Tape • Archiving a Tape • Restoring Data from a Tape Configuring Arcserve to Work with VTL Devices After you have connected your virtual tape library (VTL) devices to your client, you scan for your devices. To scan for VTL devices 1. In the Arcserve Backup Manager, choose the Utilities menu. 2. Choose Media Assure and Scan. Arcserve Backup API Version 2013-06-30 69 AWS Storage Gateway Tape Gateway User Guide Loading Tapes into a Media Pool When the Arcserve software connects to your gateway and your tapes become available, Arcserve automatically loads your tapes. If your gateway is not found in the Arcserve software, try restarting the tape engine in Arcserve. To restart the tape engine 1. Choose Quick Start, choose Administration, and then choose Device. 2. On the navigation menu, open the context (right-click) menu for your gateway and choose an import/export slot. 3. Choose Quick Import and assign your tape to an empty slot. 4. Open the context (right-click) menu for your gateway and choose Inventory/Offline Slots. 5. Choose Quick Inventory to retrieve media information from the database. If you add a new tape, you need to scan your gateway for the new tape to have it appear in Arcserve. If the new tapes don't appear, you must import the tapes. To import tapes 1. Choose the Quick Start menu, choose Back up, and then choose Destination tap. 2. Choose your gateway, open the context (right-click) menu for one tape, and then choose Import/Export Slot. 3. Open the context (right-click) menu for each new tape and choose Inventory. 4. Open the context (right-click) menu for each new tape and choose Format. Each tape's barcode now appears in your Storage Gateway console, and each tape is ready to use. Backing Up Data to a Tape When your tapes have been loaded into Arcserve, you can back up data. The backup process is the same as backing up physical tapes. To back up data to a tape 1. From the Quick Start menu, open the restore a backup session. Arcserve Backup API Version 2013-06-30 70 AWS Storage Gateway Tape Gateway User Guide 2. Choose the Source tab, and then choose the file system or database system that you want to back up. 3. Choose the Schedule tab and choose the repeat method you want to use. 4. Choose the Destination tab and then choose the tape you want to use. If the data you are backing up is larger than the tape can hold, Arcserve prompts you to mount a new tape. 5. Choose Submit to back up your data. Note If your Tape Gateway restarts for any reason during an ongoing backup job, the backup job might fail. To complete the failed backup job, you must resubmit it. Archiving a Tape When you archive a tape, your Tape Gateway moves the tape from the tape library to the offline storage. Before you eject and archive a
|
storagegateway-tgw-ug-028
|
storagegateway-tgw-ug.pdf
| 28 |
Choose the Destination tab and then choose the tape you want to use. If the data you are backing up is larger than the tape can hold, Arcserve prompts you to mount a new tape. 5. Choose Submit to back up your data. Note If your Tape Gateway restarts for any reason during an ongoing backup job, the backup job might fail. To complete the failed backup job, you must resubmit it. Archiving a Tape When you archive a tape, your Tape Gateway moves the tape from the tape library to the offline storage. Before you eject and archive a tape, you might want to check the content on it. To archive a tape 1. From the Quick Start menu, open the restore a backup session. 2. Choose the Source tab, and then choose the file system or database system you want to back up. 3. Choose the Schedule tab and choose the repeat method you want to use. 4. Choose your gateway, open the context (right-click) menu for one tape, and then choose Import/Export Slot. 5. Assign a mail slot to load the tape. The status in the Storage Gateway console changes to Archive. The archive process might take some time. The archiving process can take some time to complete. The initial status of the tape appears as IN TRANSIT TO VTS. When archiving starts, the status changes to ARCHIVING. When archiving is completed, the tape is no longer listed in the VTL but is archived in S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive. Arcserve Backup API Version 2013-06-30 71 AWS Storage Gateway Tape Gateway User Guide Restoring Data from a Tape Restoring your archived data is a two-step process. To restore data from an archived tape 1. Retrieve the archived tape to a Tape Gateway. For instructions, see Retrieving Archived Tapes. 2. Use Arcserve to restore the data. This process is the same as restoring data from physical tapes. For instructions, refer to the Arcserve Backup documentation. To restore data from a tape, use the following procedure. To restore data from a tape 1. From the Quick Start menu, open the restore a restore session. 2. Choose the Source tab, and then choose the file system or database system you want to restore. 3. Choose the Destination tab and accept the default settings. 4. Choose the Schedule tab, choose the repeat method that you want to use, and then choose Submit. Next Step Cleaning up unecessary resources Testing Your Setup by Using Bacula Enterprise You can back up your data to virtual tapes, archive the tapes, and manage your virtual tape library (VTL) devices by using Bacula Enterprise. In this topic, you can find basic documentation on how to configure the Bacula version 10 backup application for a Tape Gateway and perform backup and restore operations. For detailed information about how to use Bacula, see Bacula Systems Manuals and Documentation or contact Bacula Systems. Note Bacula is only supported on Linux. Bacula Enterprise API Version 2013-06-30 72 AWS Storage Gateway Tape Gateway User Guide Setting Up Bacula Enterprise After you have connected your virtual tape library (VTL) devices to your Linux client, you configure the Bacula software to recognize your devices. For information about how to connect VTL devices to your client, see Connecting your VTL devices. To set up Bacula 1. Get a licensed copy of the Bacula Enterprise backup software from Bacula Systems. 2. Install the Bacula Enterprise software on your on-premises or in-cloud computer. For information about how to get the installation software, see Enterprise Backup for Amazon S3 and Storage Gateway. For additional installation guidance, see the Bacula whitepaper Using Cloud Services and Object Storage with Bacula Enterprise Edition. Configuring Bacula to Work with VTL Devices Next, configure Bacula to work with your VTL devices. Following, you can find basic configuration steps. To configure Bacula 1. Install the Bacula Director and the Bacula Storage daemon. For instructions, see chapter 7 of the Using Cloud Services and Object Storage with Bacula Enterprise Edition Bacula white paper. 2. Connect to the system that is running Bacula Director and configure the iSCSI initiator. To do so, use the script provided in step 7.4 in the Using Cloud Services and Object Storage with Bacula Enterprise Edition Bacula whitepaper. 3. Configure the storage devices. Use the script provided in the Bacula whitepaper discussed preceding. 4. Configure the local Bacula Director, add storage targets, and define media pools for your tapes. Use the script provided in the Bacula whitepaper discussed preceding. Backing Up Data to Tape 1. Create tapes in the Storage Gateway console. For information on how to create tapes, see Creating Tapes. Bacula Enterprise API Version 2013-06-30 73 AWS Storage Gateway Tape Gateway User Guide 2. Transfer tapes from the I/E slot to the storage slot
|
storagegateway-tgw-ug-029
|
storagegateway-tgw-ug.pdf
| 29 |
Using Cloud Services and Object Storage with Bacula Enterprise Edition Bacula whitepaper. 3. Configure the storage devices. Use the script provided in the Bacula whitepaper discussed preceding. 4. Configure the local Bacula Director, add storage targets, and define media pools for your tapes. Use the script provided in the Bacula whitepaper discussed preceding. Backing Up Data to Tape 1. Create tapes in the Storage Gateway console. For information on how to create tapes, see Creating Tapes. Bacula Enterprise API Version 2013-06-30 73 AWS Storage Gateway Tape Gateway User Guide 2. Transfer tapes from the I/E slot to the storage slot by using the following command. /opt/bacula/scripts/mtx-changer For example, the following command transfers tapes from I/E slot 1601 to storage slot 1. /opt/bacula/scripts/mtx-changer transfer 1601 1 3. Launch the Bacula console by using the following command. /opt/bacula/bin/bconsole Note When you create and transfer a tape to Bacula, use the Bacula console (bconsole) command update slots storage=VTL so that Bacula knows about the new tapes that you created. 4. Label the tape with the barcode as the volume name or label by using the following bconsole command. label storage=VTL pool=pool.VTL barcodes === label the tapes with the barcode as the volume name / label 5. Mount the tape by using the following command. mount storage=VTL slot=1 drive=0 6. Create a backup job that uses the media pools you created, and then write data to the virtual tape by using the same procedures that you do with physical tapes. 7. Unmount the tape from the Bacula console by using the following command. umount storage=VTL slot=1 drive=0 Note If your Tape Gateway restarts for any reason during an ongoing backup job, the backup job will fail, and the tape status in Bacula Enterprise will change to FULL. If you know the tape has not been fully utilized, you can manually change the tape status back to APPEND and Bacula Enterprise API Version 2013-06-30 74 AWS Storage Gateway Tape Gateway User Guide continue the backup job using the same tape. You can also continue the job on a different tape if other tapes in APPEND status are available. Archiving a Tape When all backup jobs for a particular tape are done and you can archive the tape, use the mtx- changer script to move the tape from the storage slot to the I/E slot. This action is similar to the eject action in other backup applications. To archive a tape 1. Transfer the tape from the storage slot to the I/E slot by using the /opt/bacula/scripts/ mtx-changer command. For example, the following command transfers a tape from the storage slot 1 to I/E slot 1601. /opt/bacula/scripts/mtx-changer transfer 1 1601 2. Verify that the tape is archived in the offline storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive) and that the tape has the status Archived. Restoring Data from an Archived and Retrieved Tape Restoring your archived data is a two-step process. To restore data from an archived tape 1. Retrieve the archived tape from archive to a Tape Gateway. For instructions, see Retrieving Archived Tapes. 2. Restore your data by using the Bacula software: a. Import the tapes into the storage slot by using the /opt/bacula/scripts/mtx- changer command to transfer tapes from the I/E slot. For example, the following command transfers tapes from I/E slot 1601 to storage slot 1. /opt/bacula/scripts/mtx-changer transfer 1601 1 b. Use the Bacula console to update the slots, and then mount the tape. Bacula Enterprise API Version 2013-06-30 75 AWS Storage Gateway Tape Gateway User Guide c. Run the restore command to restore your data. For instructions, see the Bacula documentation. Testing Your Setup by Using Commvault You can back up your data to virtual tapes, archive the tapes, and manage your virtual tape library (VTL) devices by using Commvault. In this topic, you can find basic documentation on how to configure the Commvault backup application for a Tape Gateway, perform a backup archive, and retrieve your data from archived tapes. For detailed information about how to use Commvault, refer to the Commvault documentation. Topics • Configuring Commvault to Work with VTL Devices • Creating a Storage Policy and a Subclient • Backing Up Data to a Tape in Commvault • Archiving a Tape in Commvault • Restoring Data from a Tape Configuring Commvault to Work with VTL Devices After you connect the VTL devices to the Windows client, you configure Commvault to recognize them. For information about how to connect VTL devices to the Windows client, see Connecting your VTL devices to a Windows client. The Commvault backup application doesn't automatically recognize VTL devices. You must manually add devices to expose them to the Commvault backup application and then discover the devices. To configure Commvault 1. In the CommCell console main menu, choose Storage, and then choose
|
storagegateway-tgw-ug-030
|
storagegateway-tgw-ug.pdf
| 30 |
in Commvault • Archiving a Tape in Commvault • Restoring Data from a Tape Configuring Commvault to Work with VTL Devices After you connect the VTL devices to the Windows client, you configure Commvault to recognize them. For information about how to connect VTL devices to the Windows client, see Connecting your VTL devices to a Windows client. The Commvault backup application doesn't automatically recognize VTL devices. You must manually add devices to expose them to the Commvault backup application and then discover the devices. To configure Commvault 1. In the CommCell console main menu, choose Storage, and then choose Expert Storage Configuration to open the Select MediaAgents dialog box. 2. Choose the available media agent you want to use, choose Add, and then choose OK. 3. In the Expert Storage Configuration dialog box, choose Start, and then choose Detect/ Configure Devices. 4. Leave the Device Type options selected, choose Exhaustive Detection, and then choose OK. Commvault API Version 2013-06-30 76 AWS Storage Gateway Tape Gateway User Guide 5. 6. In the Confirm Exhaustive Detection confirmation box, choose Yes. In the Device Selection dialog box, choose your library and all its drives, and then choose OK. Wait for your devices to be detected, and then choose Close to close the log report. 7. Right-click your library, choose Configure, and then choose Yes. Close the configuration dialog box. 8. 9. In the Does this library have a barcode reader? dialog box, choose Yes, and then for device type, choose IBM ULTRIUM V5. In the CommCell browser, choose Storage Resources, and then choose Libraries to see your tape library. 10. To see your tapes in your library, open the context (right-click) menu for your library, and then choose Discover Media, Media location, Media Library. 11. To mount your tapes, open the context (right-click) menu for your media, and then choose Load. Creating a Storage Policy and a Subclient Every backup and restore job is associated with a storage policy and a subclient policy. A storage policy maps the original location of the data to your media. To create a storage policy 1. In the CommCell browser, choose Policies. 2. Open the context (right-click) menu for Storage Policies, and then choose New Storage Policy. 3. 4. 5. In the Create Storage Policy wizard, choose Data Protection and Archiving, and then choose Next. Type a name for Storage Policy Name, and then choose Incremental Storage Policy. To associate this storage policy with incremental loads, choose one of the options. Otherwise, leave the options unchecked, and then choose Next. In the Do you want to Use Global Deduplication Policy? dialog box, choose your Deduplication preference, and then choose Next. 6. From Library for Primary Copy, choose your VTL library, and then choose Next. 7. Verify that your media agent settings are correct, and then choose Next. Commvault API Version 2013-06-30 77 AWS Storage Gateway Tape Gateway User Guide 8. Verify that your scratch pool settings are correct, and then choose Next. 9. Configure your retention policies in iData Agent Backup data, and then choose Next. 10. Review the encryption settings, and then choose Next. 11. To see your storage policy, choose Storage Policies. You create a subclient policy and associate it with your storage policy. A subclient policy allows you to configure similar file system clients from a central template, so that you don't have to set up many similar file systems manually. To create a subclient policy 1. In the CommCell browser, choose Client Computers, and then choose your client computer. Choose File System, and then choose defaultBackupSet. 2. Right-click defaultBackupSet, choose All Tasks, and then choose New Subclient. 3. In the Subclient properties box, type a name in SubClient Name, and then choose OK. 4. Choose Browse, navigate to the files that you want to back up, choose Add, and then close the dialog box. 5. 6. In the Subclient property box, choose the Storage Device tab, choose a storage policy from Storage policy, and then choose OK. In the Backup Schedule window that appears, associate the new subclient with a backup schedule. 7. Choose Do Not Schedule for one time or on-demand backups, and then choose OK. You should now see your subclient in the defaultBackupSet tab. Backing Up Data to a Tape in Commvault You create a backup job and write data to a virtual tape by using the same procedures you use with physical tapes. For more information, refer to the Commvault documentation. Note If your Tape Gateway restarts for any reason during an ongoing backup job, the backup job might fail. In some cases, you can select an option to resume the failed job. Otherwise, you must submit a new job. If Commvault marks the tape as unusable after a job fails, you Commvault API Version 2013-06-30 78 AWS
|
storagegateway-tgw-ug-031
|
storagegateway-tgw-ug.pdf
| 31 |
subclient in the defaultBackupSet tab. Backing Up Data to a Tape in Commvault You create a backup job and write data to a virtual tape by using the same procedures you use with physical tapes. For more information, refer to the Commvault documentation. Note If your Tape Gateway restarts for any reason during an ongoing backup job, the backup job might fail. In some cases, you can select an option to resume the failed job. Otherwise, you must submit a new job. If Commvault marks the tape as unusable after a job fails, you Commvault API Version 2013-06-30 78 AWS Storage Gateway Tape Gateway User Guide must reload the tape into the drive to continue writing to it. If multiple tapes are available, Commvault might continue the failed backup job on a different tape. Archiving a Tape in Commvault You start the archiving process by ejecting the tape. When you archive a tape, Tape Gateway moves the tape from the tape library to offline storage. Before you eject and archive a tape, you might want to first check the content on the tape. To archive a tape 1. In the CommCell browser, choose Storage Resources, Libraries, and then choose Your library. Choose Media By Location, and then choose Media In Library. 2. Open the context (right-click) menu for the tape you want to archive, choose All Tasks, choose Export, and then choose OK. The archiving process can take some time to complete. The initial status of the tape appears as IN TRANSIT TO VTS. When archiving starts, the status changes to ARCHIVING. When archiving is completed, the tape is no longer listed in the VTL. In the Commvault software, verify that the tape is no longer in the storage slot. In the navigation pane of the Storage Gateway console, choose Tapes. Verify that your archived tape's status is ARCHIVED. Restoring Data from a Tape You can restore data from a tape that has never been archived and retrieved, or from a tape that has been archived and retrieved. For tapes that have never been archived and retrieved (nonretrieved tapes), you have two options to restore the data: • Restore by subclient • Restore by job ID To restore data from a nonretrieved tape by subclient 1. In the CommCell browser, choose Client Computers, and then choose your client computer. Choose File System, and then choose defaultBackupSet. Commvault API Version 2013-06-30 79 AWS Storage Gateway Tape Gateway User Guide 2. Open the context (right-click) menu for your subclient, choose Browse and Restore, and then choose View Content. 3. Choose the files you want to restore, and then choose Recover All Selected. 4. Choose Home, and then choose Job Controller to monitor the status of your restore job. To restore data from a nonretrieved tape by job ID 1. 2. 3. 4. In the CommCell browser, choose Client Computers, and then choose your client computer. Right-click File System, choose View, and then choose Backup History. In the Backup Type category, choose the type of backup jobs you want, and then choose OK. A tab with the history of backup jobs appears. Find the Job ID you want to restore, right-click it, and then choose Browse and Restore. In the Browse and Restore Options dialog box, choose View Content. 5. Choose the files that you want to restore, and then choose Recover All Selected. 6. Choose Home, and then choose Job Controller to monitor the status of your restore job. To restore data from an archived and retrieved tape 1. In the CommCell browser, choose Storage Resources, choose Libraries, and then choose Your library. Choose Media By Location, and then choose Media In Library. 2. Right-click the retrieved tape, choose All Tasks, and then choose Catalog. 3. In the Catalog Media dialog box, choose Catalog only, and then choose OK. 4. Choose CommCell Home, and then choose Job Controller to monitor the status of your restore job. 5. After the job succeeds, open the context (right-click) menu for your tape, choose View, and then choose View Catalog Contents. Take note of the Job ID value for use later. 6. Choose Recatalog/Merge. Make sure that Merge only is chosen in the Catalog Media dialog box. 7. Choose Home, and then choose Job Controller to monitor the status of your restore job. 8. After the job succeeds, choose CommCell Home, choose Control Panel, and then choose Browse/Search/Recovery. 9. Choose Show aged data during browse and recovery, choose OK, and then close the Control Panel. Commvault API Version 2013-06-30 80 AWS Storage Gateway Tape Gateway User Guide 10. In the CommCell browser, right-click Client Computers, and then choose your client computer. Choose View, and then choose Job History. 11. In the Job History Filter dialog box, choose Advanced. 12. Choose Include Aged Data, and then choose
|
storagegateway-tgw-ug-032
|
storagegateway-tgw-ug.pdf
| 32 |
box. 7. Choose Home, and then choose Job Controller to monitor the status of your restore job. 8. After the job succeeds, choose CommCell Home, choose Control Panel, and then choose Browse/Search/Recovery. 9. Choose Show aged data during browse and recovery, choose OK, and then close the Control Panel. Commvault API Version 2013-06-30 80 AWS Storage Gateway Tape Gateway User Guide 10. In the CommCell browser, right-click Client Computers, and then choose your client computer. Choose View, and then choose Job History. 11. In the Job History Filter dialog box, choose Advanced. 12. Choose Include Aged Data, and then choose OK. 13. In the Job History dialog box, choose OK to open the history of jobs tab. 14. Find the job that you want to restore, open the context (right-click) menu for it, and then choose Browse and Restore. 15. In the Browse and Restore dialog box, choose View Content. 16. Choose the files that you want to restore, and then choose Recover All Selected. 17. Choose Home, and then choose Job Controller to monitor the status of your restore job. Testing Your Setup by Using Dell EMC NetWorker You can back up your data to virtual tapes, archive the tapes and manage your virtual tape library (VTL) devices by using Dell EMC NetWorker. In this topic, you can find basic documentation on how to configure the Dell EMC NetWorker software to work with a Tape Gateway and perform a backup, including how to configure storage devices, write data to a tape, archive a tape and restore data from a tape. For detailed information about how to install and use the Dell EMC NetWorker software, see the NetWorker documentation. For more information about compatible backup applications, see Supported third-party backup applications for a Tape Gateway. Topics • Configuring to Work with VTL Devices • Allowing Import of WORM Tapes into Dell EMC NetWorker • Backing Up Data to a Tape in Dell EMC NetWorker • Archiving a Tape in Dell EMC NetWorker • Restoring Data from an Archived Tape in Dell EMC NetWorker Dell EMC NetWorker API Version 2013-06-30 81 AWS Storage Gateway Tape Gateway User Guide Configuring to Work with VTL Devices After you have connected your virtual tape library (VTL) devices to your Microsoft Windows client, you configure to recognize your devices. For information about how to connect VTL devices to the Windows client, see Connecting your VTL devices. doesn't automatically recognize Tape Gateway devices. To expose your VTL devices to the NetWorker software and get the software to discover them, you manually configure the software. Following, we assume that you have correctly installed the software and that you are familiar with the Management Console. For more information about the Management Console, see the NetWorker Management Console interface section of the Dell EMC NetWorker Administration Guide. To configure the Dell EMC NetWorker software for VTL devices 1. Start the Dell EMC NetWorker Management Console application, choose Enterprise from the menu, and then choose localhost from the left pane. 2. Open the context (right-click) menu for localhost, and then choose Launch Application. 3. Choose the Devices tab, open the context (right-click) menu for Libraries, and then choose Scan for Devices. 4. 5. In the Scan for Devices wizard, choose Start Scan, and then choose OK from the dialog box that appears. Expand the Libraries folder tree to see all your libraries and hit F5 to refresh. This process might take a few seconds to load the devices into the library. 6. Open a command window (cmd.exe) with admin privileges and run the jbconfig utility that is installed with Dell EMC NetWorker 19.5. a. At the menu prompt, enter the corresponding numeral to select Configure an Autodetected SCSI Jukebox. b. When prompted to provide a name for the jukebox device, enter a name such as AWSVTL. c. When prompted to turn NetWorker auto-cleaning on, enter no. d. When prompted to bypass auto-configure, enter no. e. When prompted to configure another jukebox, enter no. 7. When "jbconfig" completes, return to the Networker GUI and press F5 to refresh. 8. Choose your library to see your tapes in the left pane and the corresponding empty volume slots list in the right pane. Dell EMC NetWorker API Version 2013-06-30 82 AWS Storage Gateway Tape Gateway User Guide 9. 10. 11. In the volume list, select the volumes you want to activate (selected volumes are highlighted), open the context (right-click) menu for the selected volumes, and then choose Deposit. This action moves the tape from the I/E slot into the volume slot. In the dialog box that appears, choose Yes, and then in the Load the Cartridges into dialog box, choose Yes. If you don't have any more tapes to deposit, choose No or Ignore. Otherwise, choose Yes to deposit additional tapes. Allowing Import
|
storagegateway-tgw-ug-033
|
storagegateway-tgw-ug.pdf
| 33 |
Dell EMC NetWorker API Version 2013-06-30 82 AWS Storage Gateway Tape Gateway User Guide 9. 10. 11. In the volume list, select the volumes you want to activate (selected volumes are highlighted), open the context (right-click) menu for the selected volumes, and then choose Deposit. This action moves the tape from the I/E slot into the volume slot. In the dialog box that appears, choose Yes, and then in the Load the Cartridges into dialog box, choose Yes. If you don't have any more tapes to deposit, choose No or Ignore. Otherwise, choose Yes to deposit additional tapes. Allowing Import of WORM Tapes into Dell EMC NetWorker You are now ready to import tapes from your Tape Gateway into the Dell EMC NetWorker library. The virtual tapes are write once read many (WORM) tapes, but Dell EMC NetWorker expects non- WORM tapes. For Dell EMC NetWorker to work with your virtual tapes, you must activate import of tapes into non-WORM media pools. To allow import of WORM tapes into non-WORM media pools 1. On NetWorker Console, choose Media, open the context (right-click) menu for localhost, and then choose Properties. 2. 3. In the NetWorker Sever Properties window, choose the Configuration tab. In the Worm tape handling section, clear the WORM tapes only in WORM pools box, and then choose OK. Backing Up Data to a Tape in Dell EMC NetWorker Backing up data to a tape is a two-step process. 1. Label the tapes you want to back up your data to, create the target media pool, and add the tapes to the pool. You create a media pool and write data to a virtual tape by using the same procedures you do with physical tapes. For detailed information, see the Backing Up Data section of the Dell EMC NetWorker Administration Guide. 2. Write data to the tape. You back up data by using the Dell EMC NetWorker User application instead of the Dell EMC NetWorker Management Console. The Dell EMC NetWorker User application installs as part of the NetWorker installation. Dell EMC NetWorker API Version 2013-06-30 83 AWS Storage Gateway Note Tape Gateway User Guide You use the Dell EMC NetWorker User application to perform backups, but you view the status of your backup and restore jobs in the EMC Management Console. To view status, choose the Devices menu and view the status in the Log window. Note If your Tape Gateway restarts for any reason during an ongoing backup job, the backup job will be suspended, and the tape status in Dell EMC Networker will change to Write Protected. You can archive the tape or continue to read data from it. You can resume the suspended backup job on a different tape. Archiving a Tape in Dell EMC NetWorker When you archive a tape, Tape Gateway moves the tape from the Dell EMC NetWorker tape library to the offline storage. You begin tape archival by ejecting a tape from the tape drive to the storage slot. You then withdraw the tape from the slot to the archive by using your backup application— that is, the Dell EMC NetWorker software. To archive a tape by using Dell EMC NetWorker 1. On the Devices tab in the NetWorker Administration window, choose localhost or your EMC server, and then choose Libraries. 2. Choose the library you imported from your virtual tape library. 3. From the list of tapes that you have written data to, open the context (right-click) menu for the tape you want to archive, and then choose Eject/Withdraw. 4. In the confirmation box that appears, choose OK. The archiving process can take some time to complete. The initial status of the tape appears as IN TRANSIT TO VTS. When archiving starts, the status changes to ARCHIVING. When archiving is completed, the tape is no longer listed in the VTL. In the Dell EMC NetWorker software, verify that the tape is no longer in the storage slot. Dell EMC NetWorker API Version 2013-06-30 84 AWS Storage Gateway Tape Gateway User Guide In the navigation pane of the Storage Gateway console, choose Tapes. Verify that your archived tape's status is ARCHIVED. Restoring Data from an Archived Tape in Dell EMC NetWorker Restoring your archived data is a two-step process: 1. Retrieve the archived tape a Tape Gateway. For instructions, see Retrieving Archived Tapes. 2. Use the Dell EMC NetWorker software to restore the data. You do this by creating a restoring a folder file, as you do when restoring data from physical tapes. For instructions, see the Using the NetWorker User program section of the Dell EMC NetWorker Administration Guide. Next Step Cleaning up unecessary resources Testing Your Setup by Using IBM Data Protect You can back up your data to virtual tapes, archive the tapes, and manage your virtual tape
|
storagegateway-tgw-ug-034
|
storagegateway-tgw-ug.pdf
| 34 |
Restoring your archived data is a two-step process: 1. Retrieve the archived tape a Tape Gateway. For instructions, see Retrieving Archived Tapes. 2. Use the Dell EMC NetWorker software to restore the data. You do this by creating a restoring a folder file, as you do when restoring data from physical tapes. For instructions, see the Using the NetWorker User program section of the Dell EMC NetWorker Administration Guide. Next Step Cleaning up unecessary resources Testing Your Setup by Using IBM Data Protect You can back up your data to virtual tapes, archive the tapes, and manage your virtual tape library (VTL) devices by using IBM Data Protect with AWS Storage Gateway. (IBM Data Protect was formerly known as Tivoli Storage Manager.) This topic contains basic information about how to configure the IBM Data Protect backup software for a Tape Gateway. It also includes basic information about performing backup and restore operations with IBM Data Protect. For more information about how to administer IBM Data Protect backup software, refer to the IBM Data Protect documentation. The IBM Data Protect backup software supports AWS Storage Gateway on the following operating systems. • Microsoft Windows Server • Red Hat Linux For information about IBM Data Protect supported devices for Windows, see IBM Data Protect (formerly Tivoli Storage Manager) Supported Devices for AIX, HP-UX, Solaris, and Windows. For information about IBM Data Protect supported devices for Linux, see IBM Data Protect (formerly Tivoli Storage Manager) Supported Devices for Linux. IBM Data Protect API Version 2013-06-30 85 Tape Gateway User Guide AWS Storage Gateway Topics • Setting Up IBM Data Protect • Configuring IBM Data Protect to Work with VTL Devices • Writing Data to a Tape in IBM Data Protect • Restoring Data from a Tape Archived in IBM Data Protect Setting Up IBM Data Protect After you connect your VTL devices to your client, you configure the IBM Data Protect software to recognize them. For more information about connecting VTL devices to your client, see Connecting your VTL devices. To set up IBM Data Protect 1. Get a licensed copy of the IBM Data Protect software from IBM. 2. Install the IBM Data Protect software on your on-premises environment or in-cloud Amazon EC2 instance. For more information, see IBM's Installing and upgrading documentation for IBM Data Protect. For more information about configuring IBM Data Protect software, see Configuring AWS Tape Gateway virtual tape libraries for an IBM Data Protect server. Configuring IBM Data Protect to Work with VTL Devices Next, configure IBM Data Protect to work with your VTL devices. You can configure IBM Data Protect to work with VTL devices on Microsoft Windows Server or Red Hat Linux. Configuring IBM Data Protect for Windows For complete instructions on how to configure IBM Data Protect on Windows, see Tape Device Driver-W12 6266 for Windows 2012 on the Lenovo website. Following is basic documentation on the process. To configure IBM Data Protect for Microsoft Windows 1. Get the correct driver package for your media changer. For the tape-device driver, IBM Data Protect requires version W12 6266 for Windows 2012. For instructions on how to get the drivers, see Tape Device Driver-W12 6266 for Windows 2012 on the Lenovo website. IBM Data Protect API Version 2013-06-30 86 AWS Storage Gateway Note Tape Gateway User Guide Make sure that you install the "non-exclusive" set of drivers. 2. On your computer, open Computer Management, expand Media Changer devices, and verify that the media changer type is listed as IBM 3584 Tape Library. 3. Ensure that the barcode for any tape in the virtual tape library is eight characters or less. If you try to assign your tape a barcode that is longer than eight characters, you get this error message: "Tape barcode is too long for media changer". 4. Ensure that all your tape drives and media changer appear in IBM Data Protect. To do so, use the following command: \Tivoli\TSM\server>tsmdlst.exe Configure IBM Data Protect for Linux Following is basic documentation on configuring IBM Data Protect to work with VTL devices on Linux. To configure IBM Data Protect for Linux 1. Go to IBM Fix Central on the IBM Support website, and choose Select product. 2. 3. 4. 5. 6. For Product Group, choose System Storage. For Select from System Storage, choose Tape systems. For Tape systems, choose Tape drivers and software. For Select from Tape drivers and software, choose Tape device drivers. For Platform, choose your operating system and choose Continue. 7. Choose the device driver version that you want to download. Then follow the instructions on the Fix Central download page to download and configure IBM Data Protect. 8. Ensure that the barcode for any tape in the virtual tape library is eight characters or less. If you try to assign your tape a
|
storagegateway-tgw-ug-035
|
storagegateway-tgw-ug.pdf
| 35 |
3. 4. 5. 6. For Product Group, choose System Storage. For Select from System Storage, choose Tape systems. For Tape systems, choose Tape drivers and software. For Select from Tape drivers and software, choose Tape device drivers. For Platform, choose your operating system and choose Continue. 7. Choose the device driver version that you want to download. Then follow the instructions on the Fix Central download page to download and configure IBM Data Protect. 8. Ensure that the barcode for any tape in the virtual tape library is eight characters or less. If you try to assign your tape a barcode that is longer than eight characters, you get this error message: "Tape barcode is too long for media changer". Writing Data to a Tape in IBM Data Protect You write data to a Tape Gateway virtual tape by using the same procedure and backup policies that you do with physical tapes. Create the necessary configuration for backup and restore jobs. IBM Data Protect API Version 2013-06-30 87 AWS Storage Gateway Tape Gateway User Guide For more information about configuring IBM Data Protect, see Overview of administration tasks for IBM Data Protect. Note If your Tape Gateway restarts for any reason during an ongoing backup job, the backup job might fail. If the backup job fails, the tape status in IBM Data Protect changes to ReadOnly. If you know the tape has not been fully utilized, you can manually change the tape status back to ReadWrite, and either resume or resubmit the backup job using the same tape. IBM Data Protect might continue the failed backup job on a different tape if other tapes in ReadWrite status are available. Restoring Data from a Tape Archived in IBM Data Protect Restoring your archived data is a two-step process. To restore data from an archived tape 1. Retrieve the archived tape from archive to a Tape Gateway. For instructions, see Retrieving Archived Tapes. 2. Restore the data by using the IBM Data Protect backup software. You do this by creating a recovery point, as you do when restoring data from physical tapes. For more information about configuring IBM Data Protect, see Overview of administration tasks for IBM Data Protect. Next Step Cleaning up unecessary resources Testing your setup by using OpenText Data Protector You can back up your data to virtual tapes, archive the tapes, and manage your virtual tape library (VTL) devices by using OpenText Data Protector. In this topic, you can find basic documentation on how to configure the OpenText Data Protector software for a Tape Gateway and perform a backup and restore operation. For detailed information about how to use the OpenText Data Protector software, see the OpenText Data Protector documentation. For more information about compatible backup applications, see Supported third-party backup applications for a Tape Gateway. OpenText Data Protector API Version 2013-06-30 88 AWS Storage Gateway Topics • Configuring OpenText Data Protector to Work with VTL Devices • Preparing Virtual Tapes for Use with Data Protector Tape Gateway User Guide • Loading Tapes into a Media Pool • Backing Up Data to a Tape • Archiving a Tape • Restoring Data from a Tape Configuring OpenText Data Protector to Work with VTL Devices After you have connected the virtual tape library (VTL) devices to the client, you configure OpenText Data Protector to recognize your devices. For information about how to connect VTL devices to the client, see Connecting your VTL devices. The OpenText Data Protector software doesn't automatically recognize Tape Gateway devices. To have the software recognize these devices, manually add the devices and then discover the VTL devices, as described following. To add the VTL devices 1. In the OpenText Data Protector main window, choose the Devices & Media shelf in the list at top left. Open the context (right-click) menu for Devices, and choose Add Device. 2. On the Add Device tab, type a value for Device Name. For Device Type, choose SCSI Library, and then choose Next. 3. On the next screen, do the following: a. b. For SCSI address of the library robotic, select your specific address. For Select what action Data Protector should take if the drive is busy, choose "Abort" or your preferred action. c. Choose to activate these options: • Barcode reader support • Automatically discover changed SCSI address • SCSI Reserve/Release (robotic control) OpenText Data Protector API Version 2013-06-30 89 AWS Storage Gateway Tape Gateway User Guide d. Leave Use barcode as medium label on initialization clear (unchecked), unless your system requires it. e. Choose Next to continue. 4. On the next screen, specify the slots that you want to use with HP Data Protector. Use a hyphen ("-") between numbers to indicate a range of slots, for example 1–6. When you've specified slots to use, choose Next. 5. For
|
storagegateway-tgw-ug-036
|
storagegateway-tgw-ug.pdf
| 36 |
preferred action. c. Choose to activate these options: • Barcode reader support • Automatically discover changed SCSI address • SCSI Reserve/Release (robotic control) OpenText Data Protector API Version 2013-06-30 89 AWS Storage Gateway Tape Gateway User Guide d. Leave Use barcode as medium label on initialization clear (unchecked), unless your system requires it. e. Choose Next to continue. 4. On the next screen, specify the slots that you want to use with HP Data Protector. Use a hyphen ("-") between numbers to indicate a range of slots, for example 1–6. When you've specified slots to use, choose Next. 5. For the standard type of media used by the physical device, choose LTO_Ultrium, and then choose Finish to complete the setup. Your tape library is now ready to use. To load tapes into it, see the next section. Preparing Virtual Tapes for Use with Data Protector Before you can back up data to a virtual tape, you need to prepare the tape for use. Doing this involves the following actions: • Load a virtual tape into a tape library • Load the virtual tape into a slot • Create a media pool • Load the virtual tape into media pool In the following sections, you can find steps to guide you through this process. Loading Virtual Tapes into a Tape Library Your tape library should now be listed under Devices. If you don't see it, press F5 to refresh the screen. When your library is listed, you can load virtual tapes into the library. To load virtual tapes into your tape library 1. Choose the plus sign next to your tape library to display the nodes for robotics paths, drives, and slots. 2. Open the context (right-click) menu for Drives, choose Add Drive, type a name for your tape, and then choose Next to continue. 3. Choose the tape drive you want to add for SCSI address of data drive, choose Automatically discover changed SCSI address, and then choose Next. OpenText Data Protector API Version 2013-06-30 90 AWS Storage Gateway Tape Gateway User Guide 4. On the following screen, choose Advanced. The Advanced Options pop-up screen appears. a. On the Settings tab, you should consider the following options: • CRC Check (to detect accidental data changes) • Detect dirty drive (to ensure the drive is clean before backup) • SCSI Reserve/Release(drive) (to avoid tape contention) For testing purposes, you can leave these options deactivated (unchecked). b. On the Sizes tab, set the Block size (kB) to Default (256). c. Choose OK to close the advanced options screen, and then choose Next to continue. 5. On the next screen, choose these options under Device Policies: • Device may be used for restore • Device may be used as source device for object copy 6. Choose Finish to finish adding your tape drive to your tape library. Loading Virtual Tapes into Slots Now that you have a tape drive in your tape library, you can load virtual tapes into slots. To load a tape into a slot 1. In the tape library tree node, open the node labeled Slots. Each slot has a status represented by an icon: • A green tape means that a tape is already loaded into the slot. • A gray slot means that the slot is empty. • A cyan question mark means that the tape in that slot is not formatted. 2. For an empty slot, open the context (right-click) menu, and then choose Enter. If you have existing tapes, choose one to load into that slot. Creating a Media Pool A media pool is a logical group used to organize your tapes. To set up tape backup, you create a media pool. OpenText Data Protector API Version 2013-06-30 91 AWS Storage Gateway To create a media pool Tape Gateway User Guide 1. 2. 3. In the Devices & Media shelf, open the tree node for Media, open the context (right-click) menu for the Pools node, and then choose Add Media Pool. For Pool name, type a name. For Media Type, choose LTO_Ultrium, and then choose Next. 4. On the following screen, accept the default values, and then choose Next. 5. Choose Finish to finish creating a media pool. Loading Tapes into a Media Pool Before you can back up data onto your tapes, you must load the tapes into the media pool that you created. To load a virtual tape into a media pool 1. On your tape library tree node, choose the Slots node. 2. Choose a loaded tape, one that has a green icon showing a loaded tape. Open the context (right-click) menu and choose Format, and then choose Next. 3. Choose the media pool you created, and then choose Next. 4. 5. For Medium Description, choose Use barcode, and then choose Next. For
|
storagegateway-tgw-ug-037
|
storagegateway-tgw-ug.pdf
| 37 |
media pool. Loading Tapes into a Media Pool Before you can back up data onto your tapes, you must load the tapes into the media pool that you created. To load a virtual tape into a media pool 1. On your tape library tree node, choose the Slots node. 2. Choose a loaded tape, one that has a green icon showing a loaded tape. Open the context (right-click) menu and choose Format, and then choose Next. 3. Choose the media pool you created, and then choose Next. 4. 5. For Medium Description, choose Use barcode, and then choose Next. For Options, choose Force Operation, and then choose Finish. You should now see your chosen slot change from a status of unassigned (gray) to a status of tape inserted (green). A series of messages appear to confirm that your media is initialized. At this point, you should have everything configured to begin using your virtual tape library with Data Protector. To double-check that this is the case, use the following procedure. To verify that your tape library is configured for use • Choose Drives, then open the context (right-click) menu for your drive, and choose Scan. If your configuration is correct, a message confirms that your media was successfully scanned. OpenText Data Protector API Version 2013-06-30 92 AWS Storage Gateway Tape Gateway User Guide Backing Up Data to a Tape When your tapes have been loaded into a media pool, you can back up data to them. To back up data to a tape 1. Choose Backup from the drop-down menu at the top-left corner of the window. 2. Expand the Backup navigation tree from the left pane. 3. Right-click on Filesystem to open the context menu, and then choose Add Backup. 4. On the Create New Backup screen, under Filesystem, choose Blank File System Backup, and then choose OK. 5. On the tree node that shows your host system, select the file system or file systems that you want to back up, and choose Next to continue. 6. Open the tree node for the tape library you want to use, open the context (right-click) menu for the tape drive you want to use, and then choose Properties. 7. Choose your media pool, choose OK, and then choose Next. 8. For the next three screens, accept the default settings and choose Next. 9. On the Perform finishing steps in your backup/template design screen, choose Save as to save this session. In the pop-up window, give the backup a name and assign it to the group where you want to save your new backup specification. 10. Choose Start Interactive Backup. If the host system contains a database system, you can choose it as your target backup system. The screens and selections are similar to the file-system backup just described. Note If your Tape Gateway restarts for any reason during an ongoing backup job, the backup job will fail, and the tape drive in Data Protector is marked as Dirty. Data Protector also marks the tape quality as Poor, and prevents writing to the tape. To continue reading data from the tape, you must clean the drive and re-mount the tape. To complete the failed backup job, you must resubmit it on a new tape. OpenText Data Protector API Version 2013-06-30 93 AWS Storage Gateway Archiving a Tape Tape Gateway User Guide When you archive a tape, Tape Gateway moves the tape from the tape library to the offline storage. Before you eject and archive a tape, you might want to check the content on it. To check a tape's content before archiving it 1. Choose Slots and then choose the tape you want to check. 2. Choose Objects and check what content is on the tape. When you have chosen a tape to archive, use the following procedure. To eject and archive a tape 1. Open the context (right-click) menu for that tape, and choose Eject. 2. On the Storage Gateway console, choose your gateway, and then choose VTL Tape Cartridges and verify the status of the virtual tape you are archiving. After the tape is ejected, it will be automatically archived in the offline storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). The archiving process can take some time to complete. The initial status of the tape is shown as IN TRANSIT TO VTS. When archiving starts, the status changes to ARCHIVING. When archiving is completed, the tape is no longer listed in the VTL but is archived in S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive. Restoring Data from a Tape Restoring your archived data is a two-step process. To restore data from an archived tape 1. Retrieve the archived tape to a Tape Gateway. For instructions, see Retrieving Archived Tapes. 2. Use Data Protector to restore
|
storagegateway-tgw-ug-038
|
storagegateway-tgw-ug.pdf
| 38 |
Glacier Deep Archive). The archiving process can take some time to complete. The initial status of the tape is shown as IN TRANSIT TO VTS. When archiving starts, the status changes to ARCHIVING. When archiving is completed, the tape is no longer listed in the VTL but is archived in S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive. Restoring Data from a Tape Restoring your archived data is a two-step process. To restore data from an archived tape 1. Retrieve the archived tape to a Tape Gateway. For instructions, see Retrieving Archived Tapes. 2. Use Data Protector to restore the data. This process is the same as restoring data from physical tapes. To restore data from a tape, use the following procedure. To restore data from a tape 1. Choose Restore from the drop-down menu at the top-left corner of the window. OpenText Data Protector API Version 2013-06-30 94 AWS Storage Gateway Tape Gateway User Guide 2. Choose the file system or database system you want to restore from the left navigation tree. For the backup that you want to restore, make sure that the box is selected. Choose Restore. 3. 4. In the Start Restore Session window, choose Needed Media. Choose All media, and you should see the tape originally used for the backup. Choose that tape, and then choose Close. In the Start Restore Session window, accept the default settings, choose Next, and then choose Finish. Next Step Cleaning up unecessary resources Testing your setup by using Microsoft System Center DPM You can back up your data to virtual tapes, archive the tapes, and manage your virtual tape library (VTL) devices by using Microsoft System Center Data Protection Manager (DPM). In this topic, you can find basic documentation on how to configure the DPM backup application for a Tape Gateway and perform a backup and restore operation. For detailed information about how to use DPM, see the DPM documentation on the Microsoft System Center website. For more information about compatible backup applications, see Supported third-party backup applications for a Tape Gateway. Topics • Configuring DPM to Recognize VTL Devices • Importing a Tape into DPM • Writing Data to a Tape in DPM • Archiving a Tape by Using DPM • Restoring Data from a Tape Archived in DPM Configuring DPM to Recognize VTL Devices After you have connected the virtual tape library (VTL) devices to the Windows client, you configure DPM to recognize your devices. For information about how to connect VTL devices to the Windows client, see Connecting your VTL devices. By default, the DPM server does not recognize Tape Gateway devices. To configure the server to work with the Tape Gateway devices, you perform the following tasks: Microsoft System Center DPM API Version 2013-06-30 95 AWS Storage Gateway Tape Gateway User Guide 1. Update the device drivers for the VTL devices to expose them to the DPM server. 2. Manually map the VTL devices to the DPM tape library. To update the VTL device drivers • In Device Manager, update the driver for the medium changer. For instructions, see Updating the Device Driver for Your Medium Changer. You use the DPMDriveMappingTool to map your tape drives to the DPM tape library. To map tape drives to the DPM server tape library 1. Create at least one tape for your gateway. For information on how to do this on the console, see Creating Tapes. 2. Import the tape into the DPM library. For information on how to do this, see Importing a Tape into DPM. 3. If the DPMLA service is running, stop it by opening a command terminal and typing the following on the command line. net stop DPMLA 4. Locate the following file on the DPM server: %ProgramFiles%\System Center\DPM\DPM \Config\DPMLA.xml. Note The directory path might change depending on your version of System Center or DPM. If this file exists, the DPMDriveMappingTool overwrites it. If you want to preserve your original file, create a backup copy. 5. Open a command terminal, change the directory to %ProgramFiles%\System Center\DPM \DPM\Bin, and run the following command. Note The directory path might change depending on your version of System Center or DPM. Microsoft System Center DPM API Version 2013-06-30 96 AWS Storage Gateway Tape Gateway User Guide C:\Microsoft System Center\DPM\DPM\bin>DPMDriveMappingTool.exe The output for the command looks like the following. Performing Device Inventory ... Mapping Drives to Library ... Adding Standalone Drives ... Writing the Map File ... Drive Mapping Completed Successfully. Importing a Tape into DPM You are now ready to import tapes from your Tape Gateway into the DPM backup application library. To import tapes into the DPM backup application library 1. On the DPM server, open the Management Console, choose Rescan, and then choose Refresh. The Management Console displays your medium changer and tape drives. 2.
|
storagegateway-tgw-ug-039
|
storagegateway-tgw-ug.pdf
| 39 |
2013-06-30 96 AWS Storage Gateway Tape Gateway User Guide C:\Microsoft System Center\DPM\DPM\bin>DPMDriveMappingTool.exe The output for the command looks like the following. Performing Device Inventory ... Mapping Drives to Library ... Adding Standalone Drives ... Writing the Map File ... Drive Mapping Completed Successfully. Importing a Tape into DPM You are now ready to import tapes from your Tape Gateway into the DPM backup application library. To import tapes into the DPM backup application library 1. On the DPM server, open the Management Console, choose Rescan, and then choose Refresh. The Management Console displays your medium changer and tape drives. 2. Open the context (right-click) menu for the media changer in the Library section, and then choose Add tape (I/E port) to add a tape to the Slots list. Note The process of adding tapes can take several minutes to complete. The tape label appears as Unknown, and the tape is not usable. For the tape to be usable, you must identify it. Microsoft System Center DPM API Version 2013-06-30 97 AWS Storage Gateway Tape Gateway User Guide 3. Open the context (right-click) menu for the tape you want to identify, and then choose Identify unknown tape. Note The process of identifying tapes can take a few seconds or a few minutes. If the tapes don’t display barcodes correctly, you need to change the media changer driver to Sun/StorageTek Library. For more information, see Displaying Barcodes for Tapes in Microsoft System Center DPM. When identification is complete, the tape label changes to Free. That is, the tape is free for data to be written to it. Writing Data to a Tape in DPM You write data to a Tape Gateway virtual tape by using the same protection procedures and policies you do with physical tapes. You create a protection group and add the data you want to back up, and then back up the data by creating a recovery point. For detailed information about how to use DPM, see the DPM documentation on the Microsoft System Center website. By default, the capacity of a tape is 30GB. When you backup data that is larger than a tape's capacity, a device I/O error occurs. If the position where the error occurred is larger than the size of the tape, Microsoft DPM treats the error as an indication of end of tape. If the position where the error occurred is less than the size of the tape, the backup job fails. To resolve the issue, change the TapeSize value in the registry entry to match the size of your tape. For information about how to do this, see Error ID: 30101 at the Microsoft System Center. Note If your Tape Gateway restarts for any reason during an ongoing backup job, the backup job will fail. To complete the failed backup job, you must resubmit it. Microsoft System Center DPM API Version 2013-06-30 98 AWS Storage Gateway Tape Gateway User Guide Archiving a Tape by Using DPM When you archive a tape, Tape Gateway moves the tape from the DPM tape library to offline storage. You begin tape archival by removing the tape from the slot using your backup application —that is, DPM. To archive a tape in DPM 1. Open the context (right-click) menu for the tape you want to archive, and then choose Remove tape (I/E port). 2. In the dialog box that appears, choose Yes. Doing this ejects the tape from the medium changer's storage slot and moves the tape into one of the gateway's I/E slots. When a tape is moved into the gateway's I/E slot, it is immediately sent for archiving. 3. On the Storage Gateway console, choose your gateway, and then choose VTL Tape Cartridges and verify the status of the virtual tape you are archiving. The archiving process can take some time to complete. The initial status of the tape is shown as IN TRANSIT TO VTS. When archiving starts, the status changes to ARCHIVING. When archiving is completed, the tape is no longer listed in the VTL. Restoring Data from a Tape Archived in DPM Restoring your archived data is a two-step process. To restore data from an archived tape 1. Retrieve the archived tape from archive to a Tape Gateway. For instructions, see Retrieving Archived Tapes. 2. Use the DPM backup application to restore the data. You do this by creating a recovery point, as you do when restoring data from physical tapes. For instructions, see Recovering Client Computer Data on the DPM website. Next Step Cleaning up unecessary resources Microsoft System Center DPM API Version 2013-06-30 99 AWS Storage Gateway Tape Gateway User Guide Testing your setup by using NovaStor DataCenter You can back up your data to virtual tapes, archive the tapes, and manage your virtual tape library (VTL) devices by using NovaStor
|
storagegateway-tgw-ug-040
|
storagegateway-tgw-ug.pdf
| 40 |
archive to a Tape Gateway. For instructions, see Retrieving Archived Tapes. 2. Use the DPM backup application to restore the data. You do this by creating a recovery point, as you do when restoring data from physical tapes. For instructions, see Recovering Client Computer Data on the DPM website. Next Step Cleaning up unecessary resources Microsoft System Center DPM API Version 2013-06-30 99 AWS Storage Gateway Tape Gateway User Guide Testing your setup by using NovaStor DataCenter You can back up your data to virtual tapes, archive the tapes, and manage your virtual tape library (VTL) devices by using NovaStor DataCenter/Network. In this topic, you can find basic documentation on how to configure the NovaStor DataCenter/Network backup application for a Tape Gateway and perform backup and restore operations. For detailed information about how to use NovaStor DataCenter/Network, refer to the NovaStor DataCenter/Network documentation. Setting Up NovaStor DataCenter/Network After you have connected your virtual tape library (VTL) devices to your Microsoft Windows client, you configure the NovaStor software to recognize your devices. For information about how to connect VTL devices to your Windows client, see Connecting your VTL devices. NovaStor DataCenter/Network requires drivers from the driver manufacturers. You can use the Windows drivers, but you must first deactivate other backup applications. Configuring NovaStor DataCenter/Network to Work with VTL Devices When configuring your VTL devices to work with NovaStor DataCenter/Network, you might see an error message that reads External Program did not exit correctly. This issue requires a workaround, which you need to perform before you continue. You can prevent the issue by creating the workaround before you start configuring your VTL devices. For information about how to create the workaround, see Resolving an "External Program Did Not Exit Correctly" Error. To configure NovaStor DataCenter/Network to work with VTL devices 1. 2. In the NovaStor DataCenter/Network Admin console, choose Media Management, and then choose Storage Management. In the Storage Targets menu, open the context menu (right-click) for Media Management Servers, choose New, and choose OK to create and prepopulate a storage node. If you see an error message that says External Program did not exit correctly, resolve the issue before you continue. This issue requires a workaround. For information about how to resolve this issue, see Resolving an "External Program Did Not Exit Correctly" Error. NovaStor DataCenter/Network API Version 2013-06-30 100 AWS Storage Gateway Tape Gateway User Guide Important This error occurs because the element assignment range from AWS Storage Gateway for storage drives and tape drives exceeds the number that NovaStor DataCenter/ Network allows. 3. Open the context (right-click) menu for the storage node that was created, and choose New Library. 4. Choose the library server from the list. The library list is automatically populated. 5. Name the library and choose OK. 6. Choose the library to display all the properties of the Storage Gateway virtual tape library. 7. 8. 9. In the Storage Targets menu, expand Backup Servers, open the context (right-click) menu for the server, and choose Attach Library. In the Attach Library dialog box that appears, choose the LTO5 media type, and then choose OK. Expand Backup Servers to see the Storage Gateway virtual tape library and the library partition that shows all the mounted tape drives. Creating a Tape Pool A tape pool is dynamically created in the NovaStor DataCenter/Network software and so doesn't contain a fixed number of media. A tape pool that needs a tape gets it from its scratch pool. A scratch pool is a reservoir of tapes that are freely available for one or more tape pools to use. A tape pool returns to the scratch pool any media that have exceeded their retention times and that are no longer needed. Creating a tape pool is a three-step task: 1. You create a scratch pool. 2. You assign tapes to the scratch pool. 3. You create a tape pool. NovaStor DataCenter/Network API Version 2013-06-30 101 AWS Storage Gateway To create a scratch pool Tape Gateway User Guide 1. In the left navigation menu, choose the Scratch Pools tab. 2. Open the context (right-click) menu for Scratch Pools, and choose Create Scratch Pool. 3. In the Scratch Pools dialog box, name your scratch pool, and then choose your media type. 4. Choose Label Volume, and create a low water mark for the scratch pool. When the scratch pool is emptied down to the low water mark, a warning appears. 5. In the warning dialog box that appears, choose OK to create the scratch pool. To assign tapes to a scratch pool 1. In the left navigation menu, choose Tape Library Management. 2. Choose the Library tab to see your library's inventory. 3. Choose the tapes that you want to assign to the scratch pool. Make sure that the tapes are set to the correct
|
storagegateway-tgw-ug-041
|
storagegateway-tgw-ug.pdf
| 41 |
and then choose your media type. 4. Choose Label Volume, and create a low water mark for the scratch pool. When the scratch pool is emptied down to the low water mark, a warning appears. 5. In the warning dialog box that appears, choose OK to create the scratch pool. To assign tapes to a scratch pool 1. In the left navigation menu, choose Tape Library Management. 2. Choose the Library tab to see your library's inventory. 3. Choose the tapes that you want to assign to the scratch pool. Make sure that the tapes are set to the correct media type. 4. Open the context (right-click) menu for the library and choose Add to Scratch Pool. You now have a filled scratch pool that you can use for tape pools. To create a tape pool 1. From the left navigation menu, choose Tape Library Management. 2. Open the context (right-click) menu for the Media Pools tab and choose Create Media Pool. 3. Name the media pool and choose Backup Server. 4. Choose a library partition for the media pool. 5. Choose the scratch pool that you want the pool to get the tapes from. 6. For Schedule, choose Not Scheduled. Configuring Media Import and Export to Archive Tapes NovaStor DataCenter/Network can use import/export slots if they are part of the media changer. For an export, NovaStor DataCenter/Network must know which tapes are going to be physically taken out of the library. NovaStor DataCenter/Network API Version 2013-06-30 102 AWS Storage Gateway Tape Gateway User Guide For an import, NovaStor DataCenter/Network recognizes tape media that are exported in the tape library and offers to import them all, either from a data slot or an export slot. Your Tape Gateway archives tapes in the offline storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). To configure media import and export 1. Navigate to Tape Library Management, choose a server for Media Management Server, and then choose Library. 2. Choose the Off-site Locations tab. 3. Open the context (right-click) menu for the white area, and choose Add to open a new panel. 4. In the panel, type S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive and add an optional description in the text box. Backing Up Data to Tape You create a backup job and write data to a virtual tape by using the same procedures that you do with physical tapes. For detailed information about how to back up data using the NovaStor software, see Documentation NovaStor DataCenter/Network. Note If your Tape Gateway restarts for any reason during an ongoing backup job, the backup job will fail, and the tape will become unwriteable. You can archive the tape or continue to read data from it. To complete the failed backup job, you must resubmit it on a new tape. Archiving a Tape When you archive a tape, a Tape Gateway ejects the tape from the tape drive to the storage slot. It then exports the tape from the slot to the archive by using your backup application—that is, NovaStor DataCenter/Network. To archive a tape 1. In the left navigation menu, choose Tape Library Management. 2. Choose the Library tab to see the library's inventory. 3. Highlight the tapes you want to archive, open the context (right-click) menu for the tapes, and choose your off-site archive location. NovaStor DataCenter/Network API Version 2013-06-30 103 AWS Storage Gateway Tape Gateway User Guide The archiving process can take some time to complete. The initial status of the tape appears as IN TRANSIT TO VTS. When archiving starts, the status changes to ARCHIVING. When archiving is completed, the tape is no longer listed in the VTL. In NovaStor DataCenter/Network, verify that the tape is no longer in the storage slot. In the navigation pane of the Storage Gateway console, choose Tapes. Verify that your archived tape's status is ARCHIVED. Restoring Data from an Archived and Retrieved Tape Restoring your archived data is a two-step process. To restore data from an archived tape 1. Retrieve the archived tape from archive to a Tape Gateway. For instructions, see Retrieving Archived Tapes. 2. Use the NovaStor DataCenter/Network software to restore the data. You do this by refreshing the mail slot and moving each tape you want to retrieve into an empty slot, as you do when restoring data from physical tapes. For information about restoring data, see Documentation NovaStor DataCenter/Network. Writing Several Backup Jobs to a Tape Drive at the Same Time In the NovaStor software, you can write several jobs to a tape drive at the same time using the multiplexing feature. This feature is available when a multiplexer is available for a media pool. For information about how to use multiplexing, see Documentation NovaStor DataCenter/Network. Resolving an "External Program Did Not Exit Correctly" Error When configuring
|
storagegateway-tgw-ug-042
|
storagegateway-tgw-ug.pdf
| 42 |
mail slot and moving each tape you want to retrieve into an empty slot, as you do when restoring data from physical tapes. For information about restoring data, see Documentation NovaStor DataCenter/Network. Writing Several Backup Jobs to a Tape Drive at the Same Time In the NovaStor software, you can write several jobs to a tape drive at the same time using the multiplexing feature. This feature is available when a multiplexer is available for a media pool. For information about how to use multiplexing, see Documentation NovaStor DataCenter/Network. Resolving an "External Program Did Not Exit Correctly" Error When configuring your VTL devices to work with NovaStor DataCenter/Network, you might see an error message that reads External Program did not exit correctly. This error occurs because the element assignment range from Storage Gateway for storage drives and tape drives exceeds the number that NovaStor DataCenter/Network allows. Storage Gateway returns 3200 storage and import/export slots, which is more than the 2400 limit that NovaStor DataCenter/Network allows. To resolve this issue, you add a configuration file that activates the NovaStor software to limit the number of storage and import/export slots and preconfigures the element assignment range. NovaStor DataCenter/Network API Version 2013-06-30 104 AWS Storage Gateway Tape Gateway User Guide To apply the workaround for an "external program did not exit correctly" error 1. Navigate to the Tape folder on your computer where you installed the NovaStor software. 2. In the Tape folder, create a text file and name it hijacc.ini. 3. Copy the following content, paste it into hijacc.ini file, and save the file. port:12001 san:no define: A3B0S0L0 *DRIVES: 10 *FIRST_DRIVE: 10000 *SLOTS: 200 *FIRST_SLOT: 20000 *HANDLERS: 1 *FIRST_HANDLER: 0 *IMP-EXPS: 30 *FIRST_IMP-EXP: 30000 4. Add and attach the library to the media management server. 5. Move a tape from the import/export slot into the library by using the following command. Replace the example library name with the name of the library in your deployment. C:\Program Files\NovaStor\DataCenter\Hitback\tape\ophijacc.exe -c VTL- ec2amaz-uko8jfj-ec2amaz-uko8jfj.lcfg 6. Attach the library to the backup server. 7. In the NovaStor software, import all the tapes from import/export slots into the library. Testing your setup by using Quest NetVault Backup You can back up your data to virtual tapes, archive the tapes, and manage your virtual tape library (VTL) devices by using Quest (formerly Dell) NetVault Backup. In this topic, you can find basic documentation on how to configure the Quest NetVault Backup application for a Tape Gateway and perform a backup and restore operation. For detailed information about how to use the Quest NetVault Backup application, see the Quest NetVault Backup – Administration Guide. For more information about compatible backup applications, see Supported third-party backup applications for a Tape Gateway. Quest NetVault Backup API Version 2013-06-30 105 AWS Storage Gateway Topics • Configuring Quest NetVault Backup to Work with VTL Devices • Backing Up Data to a Tape in the Quest NetVault Backup • Archiving a Tape by Using the Quest NetVault Backup • Restoring Data from a Tape Archived in Quest NetVault Backup Tape Gateway User Guide Configuring Quest NetVault Backup to Work with VTL Devices After you have connected the virtual tape library (VTL) devices to the Windows client, you configure Quest NetVault Backup to recognize your devices. For information about how to connect VTL devices to the Windows client, see Connecting your VTL devices. The Quest NetVault Backup application doesn't automatically recognize Tape Gateway devices. You must manually add the devices to expose them to the Quest NetVault Backup application and then discover the VTL devices. Adding VTL Devices To add the VTL devices 1. In Quest NetVault Backup, choose Manage Devices in the Configuration tab. 2. On the Manage Devices page, choose Add Devices. 3. In the Add Storage Wizard, choose Tape library / media changer, and then choose Next. 4. On the next page, choose the client machine that is physically attached to the library and choose Next to scan for devices. 5. If devices are found, they are displayed. In this case, your medium changer is displayed in the device box. 6. Choose your medium changer and choose Next. Detailed information about the device is displayed in the wizard. 7. On the Add Tapes to Bays page, choose Scan For Devices, choose your client machine, and then choose Next. Quest NetVault Backup displays all of your drives, and the 10 bays to which you can add your drives. The bays are displayed one at a time. 8. Choose the drive you want to add to the bay that is displayed, and then choose Next. Quest NetVault Backup API Version 2013-06-30 106 AWS Storage Gateway Tape Gateway User Guide Important When you add a drive to a bay, the drive and bay numbers must match. For example, if bay 1 is displayed, you must add
|
storagegateway-tgw-ug-043
|
storagegateway-tgw-ug.pdf
| 43 |
to Bays page, choose Scan For Devices, choose your client machine, and then choose Next. Quest NetVault Backup displays all of your drives, and the 10 bays to which you can add your drives. The bays are displayed one at a time. 8. Choose the drive you want to add to the bay that is displayed, and then choose Next. Quest NetVault Backup API Version 2013-06-30 106 AWS Storage Gateway Tape Gateway User Guide Important When you add a drive to a bay, the drive and bay numbers must match. For example, if bay 1 is displayed, you must add drive 1. If a drive is not connected, leave its matching bay empty. 9. When your client machine appears, choose it, and then choose Next. The client machine can appear multiple times. 10. When the drives are displayed, repeat steps 7 through 9 to add all the drives to the bays. 11. In the Configuration tab, choose Manage devices and on the Manage Devices page, expand your medium changer to see the devices that you added. Backing Up Data to a Tape in the Quest NetVault Backup You create a backup job and write data to a virtual tape by using the same procedures you do with physical tapes. For detailed information about how to back up data, see the Quest NetVault Backup - Administration Guide. Note If your Tape Gateway restarts for any reason during an ongoing backup job, the backup job will fail. To complete the failed backup job, you must resubmit it. Archiving a Tape by Using the Quest NetVault Backup When you archive a tape, a Tape Gateway ejects the tape from the tape drive to the storage slot. It then exports the tape from the slot to the archive by using your backup application—that is, the Quest NetVault Backup. To archive a tape in Quest NetVault Backup 1. In the Quest NetVault Backup Configuration tab, choose and expand your medium changer to see your tapes. 2. Choose the settings icon for Slots to open the Slots Browser for the medium changer. 3. In the slots, choose the tape you want to archive, and then choose Export. Quest NetVault Backup API Version 2013-06-30 107 AWS Storage Gateway Tape Gateway User Guide The archiving process can take some time to complete. The initial status of the tape appears as IN TRANSIT TO VTS. When archiving starts, the status changes to ARCHIVING. When archiving is completed, the tape is no longer listed in the VTL. In the Quest NetVault Backup software, verify that the tape is no longer in the storage slot. In the navigation pane of the Storage Gateway console, choose Tapes. Verify that your archived tape's status is ARCHIVED. Restoring Data from a Tape Archived in Quest NetVault Backup Restoring your archived data is a two-step process. To restore data from an archived tape 1. Retrieve the archived tape from archive to a Tape Gateway. For instructions, see Retrieving Archived Tapes. 2. Use the Quest NetVault Backup application to restore the data. You do this by creating a restoring a folder file, as you do when restoring data from physical tapes. For instructions on creating a restore job, see Quest NetVault Backup - Administration Guide. Next Step Cleaning up unecessary resources Testing your setup by using Veeam Backup and Replication You can back up your data to virtual tapes, archive the tapes, and manage your virtual tape library (VTL) devices by using Veeam Backup & Replication. In this topic, you can find basic documentation on how to configure the Veeam Backup & Replication software for a Tape Gateway and perform a backup and restore operation. For detailed information about how to use the Veeam software, refer to the Veeam Backup & Replication documentation. For more information about compatible backup applications, see Supported third-party backup applications for a Tape Gateway. Topics • Configuring Veeam to Work with VTL Devices • Importing a Tape into Veeam • Backing Up Data to a Tape in Veeam Veeam Backup & Replication API Version 2013-06-30 108 AWS Storage Gateway Tape Gateway User Guide • Archiving a Tape by Using Veeam • Restoring Data from a Tape Archived in Veeam Configuring Veeam to Work with VTL Devices After you have connected your virtual tape library (VTL) devices to the Windows client, you configure Veeam Backup & Replication to recognize your devices. For information about how to connect VTL devices to the Windows client, see Connecting your VTL devices. Updating VTL Device Drivers To configure the software to work with Tape Gateway devices, you update the device drivers for the VTL devices to expose them to the Veeam software and then discover the VTL devices. In Device Manager, update the driver for the medium changer. For instructions, see Updating the Device Driver for
|
storagegateway-tgw-ug-044
|
storagegateway-tgw-ug.pdf
| 44 |
to Work with VTL Devices After you have connected your virtual tape library (VTL) devices to the Windows client, you configure Veeam Backup & Replication to recognize your devices. For information about how to connect VTL devices to the Windows client, see Connecting your VTL devices. Updating VTL Device Drivers To configure the software to work with Tape Gateway devices, you update the device drivers for the VTL devices to expose them to the Veeam software and then discover the VTL devices. In Device Manager, update the driver for the medium changer. For instructions, see Updating the Device Driver for Your Medium Changer. Discovering VTL Devices You must use native SCSI commands instead of a Windows driver to discover your tape library if your media changer is unknown. For detailed instructions, see Tape Libraries. To discover VTL devices 1. 2. 3. In the Veeam software, choose Tape Infrastructure. When the Tape Gateway is connected, virtual tapes are listed in the Tape Infrastructure tab. Expand the Tape tree to see your tape drives and medium changer. Expand the medium changer tree. If your tape drives are mapped to the medium changer, the drives appear under Drives. Otherwise, your tape library and tape drives appear as separate devices. If the drives are not mapped automatically, follow the instructions on the Veeam website to map the drives. Importing a Tape into Veeam You are now ready to import tapes from your Tape Gateway into the Veeam backup application library. Veeam Backup & Replication API Version 2013-06-30 109 AWS Storage Gateway Tape Gateway User Guide To import a tape into the Veeam library 1. Open the context (right–click) menu for the medium changer, and choose Import to import the tapes to the I/E slots. 2. Open the context (right–click) menu for the medium charger, and choose Inventory Library to identify unrecognized tapes. When you load a new virtual tape into a tape drive for the first time, the tape is not recognized by the Veeam backup application. To identify the unrecognized tape, you inventory the tapes in the tape library. Backing Up Data to a Tape in Veeam Backing data to a tape is a two-step process: 1. You create a media pool and add the tape to the media pool. 2. You write data to the tape. You create a media pool and write data to a virtual tape by using the same procedures you do with physical tapes. For detailed information about how to back up data, see the Getting Started with Tapes in the Veeam Help Center. Note If your Tape Gateway restarts for any reason during an ongoing backup job, the backup job will fail. To complete the failed backup job, you must resubmit it. Archiving a Tape by Using Veeam When you archive a tape, Tape Gateway moves the tape from the Veeam tape library to the offline storage. You begin tape archival by ejecting from the tape drive to the storage slot and then exporting the tape from the slot to the archive by using your backup application—that is, the Veeam software. To archive a tape in the Veeam library 1. Choose Tape Infrastructure, and choose the media pool that contains the tape you want to archive. Veeam Backup & Replication API Version 2013-06-30 110 AWS Storage Gateway Tape Gateway User Guide 2. Open the context (right–click) menu for the tape that you want to archive, and then choose Eject Tape. 3. For Ejecting tape, choose Close. The location of the tape changes from a tape drive to a slot. 4. Open the context (right–click) menu for the tape again, and then choose Export. The status of the tape changes from Tape drive to Offline. 5. For Exporting tape, choose Close. The location of the tape changes from Slot to Offline. 6. On the Storage Gateway console, choose your gateway, and then choose VTL Tape Cartridges and verify the status of the virtual tape you are archiving. The archiving process can take some time to complete. The initial status of the tape appears as IN TRANSIT TO VTS. When archiving starts, the status changes to ARCHIVING. When archiving is completed, the tape is no longer listed in the VTL but is archived in S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive. Restoring Data from a Tape Archived in Veeam Restoring your archived data is a two-step process. To restore data from an archived tape 1. Retrieve the archived tape from archive to a Tape Gateway. For instructions, see Retrieving Archived Tapes. 2. Use the Veeam software to restore the data. You do this by creating a restoring a folder file, as you do when restoring data from physical tapes. For instructions, see Restoring Files from Tape in the Veeam Help Center. Next Step Cleaning up unecessary resources
|
storagegateway-tgw-ug-045
|
storagegateway-tgw-ug.pdf
| 45 |
VTL but is archived in S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive. Restoring Data from a Tape Archived in Veeam Restoring your archived data is a two-step process. To restore data from an archived tape 1. Retrieve the archived tape from archive to a Tape Gateway. For instructions, see Retrieving Archived Tapes. 2. Use the Veeam software to restore the data. You do this by creating a restoring a folder file, as you do when restoring data from physical tapes. For instructions, see Restoring Files from Tape in the Veeam Help Center. Next Step Cleaning up unecessary resources Testing Your Setup by Using Veritas Backup Exec You can back up your data to virtual tapes, archive the tapes, and manage your virtual tape library (VTL) devices by using Veritas Backup Exec. In this topic, you can find basic documentation needed to perform backup and restore operations using Backup Exec. Veritas Backup Exec API Version 2013-06-30 111 AWS Storage Gateway Tape Gateway User Guide For more detailed information about how to use Backup Exec, including how to create secure backups, software and hardware compatibility lists, and administrator guides, refer to the Veritas support website. For more information about supported backup applications, see Supported third-party backup applications for a Tape Gateway. Topics • Configuring Storage in Backup Exec • Importing a Tape in Backup Exec • Writing Data to a Tape in Backup Exec • Archiving a Tape Using Backup Exec • Restoring Data from a Tape Archived in Backup Exec • Deactivating a Tape Drive in Backup Exec Configuring Storage in Backup Exec After you have connected the virtual tape library (VTL) devices to the Windows client, you configure Backup Exec storage to recognize your devices. For information about how to connect VTL devices to the Windows client, see Connecting your VTL devices. To configure storage 1. Start the Backup Exec software, and then choose the yellow icon in top-left corner on the toolbar. 2. Choose Configuration and Settings, and then choose Backup Exec Services to open the Backup Exec Service Manager. 3. Choose Restart All Services. Backup Exec then recognizes the VTL devices (that is, the medium changer and tape drives). The restart process might take a few minutes. Note Tape Gateway provides 10 tape drives. However, your Backup Exec license agreement might require your backup application to work with fewer than 10 tape drives. In that case, you must deactivate tape drives in the Backup Exec robotic library to leave Veritas Backup Exec API Version 2013-06-30 112 AWS Storage Gateway Tape Gateway User Guide only the number of tape drives allowed by your license agreement actuvated. For instructions, see Deactivating a Tape Drive in Backup Exec . 4. After the restart is completed, close the Backup Exec Service Manager. Importing a Tape in Backup Exec You are now ready to import a tape from your gateway into a slot. 1. Choose the Storage tab, and then expand the Robotic library tree to display the VTL devices. Important Veritas Backup Exec software requires the Tape Gateway medium changer type. If the medium changer type listed under Robotic library is not Tape Gateway, you must change it before you configure storage in the backup application. For information about how to select a different medium changer type, see Selecting a Medium Changer After Gateway Activation. 2. Choose the Slots icon to display all slots. Note When you import tapes into the robotic library, the tapes are stored in slots instead of tape drives. Therefore, the tape drives might have a message that indicates there is no media in the drives (No media). When you initiate a backup or restore job, the tapes are moved into the tape drives. You must have tapes available in your gateway tape library to import a tape into a storage slot. For instructions on how to create tapes, see Creating new virtual tapes for Tape Gateway. 3. Open the context (right-click) menu for an empty slot, choose Import, and then choose Import media now. You can select more than one slot and import multiple tapes in a single import operation. 4. 5. In the Media Request window that appears, choose View details. In the Action Alert: Media Intervention window, choose Respond OK to insert the media into the slot. Veritas Backup Exec API Version 2013-06-30 113 AWS Storage Gateway Tape Gateway User Guide The tape appears in the slot you selected. Note Tapes that are imported include empty tapes and tapes that have been retrieved from the archive to the gateway. Writing Data to a Tape in Backup Exec You write data to a Tape Gateway virtual tape by using the same procedure and backup policies you do with physical tapes. For detailed information, see the Backup Exec Administrative Guide in the documentation section in
|
storagegateway-tgw-ug-046
|
storagegateway-tgw-ug.pdf
| 46 |
Alert: Media Intervention window, choose Respond OK to insert the media into the slot. Veritas Backup Exec API Version 2013-06-30 113 AWS Storage Gateway Tape Gateway User Guide The tape appears in the slot you selected. Note Tapes that are imported include empty tapes and tapes that have been retrieved from the archive to the gateway. Writing Data to a Tape in Backup Exec You write data to a Tape Gateway virtual tape by using the same procedure and backup policies you do with physical tapes. For detailed information, see the Backup Exec Administrative Guide in the documentation section in the Backup Exec software. Note If your Tape Gateway restarts for any reason during an ongoing backup job, the backup job might fail. If the backup job fails, the tape status in Veritas Backup Exec changes to Not Appendable. You can archive the tape or continue to read data from it. To complete the failed backup job, you must resubmit it on a new tape. Archiving a Tape Using Backup Exec When you archive a tape, Tape Gateway moves the tape from your gateway’s virtual tape library (VTL) to the offline storage. You begin tape archival by exporting the tape using your Backup Exec software. To archive your tape 1. Choose the Storage menu, choose Slots, open the context (right-click) menu for the slot you want to export the tape from, choose Export media, and then choose Export media now. You can select more than one slot and export multiple tapes in a single export operation. 2. In the Media Request pop-up window, choose View details, and then choose Respond OK in the Alert: Media Intervention window. In the Storage Gateway console, you can verify the status of the tape you are archiving. It might take some time to finish uploading data to AWS. During this time, the exported tape Veritas Backup Exec API Version 2013-06-30 114 AWS Storage Gateway Tape Gateway User Guide is listed in the Tape Gateway VTL with the status IN TRANSIT TO VTS. When the upload is completed and the archiving process begins, the status changes to ARCHIVING. When data archiving has completed, the exported tape is no longer listed in the VTL but is archived in S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive. 3. Choose your gateway, and then choose VTL Tape Cartridges and verify that the virtual tape is no longer listed in your gateway. 4. On the Navigation pane of the Storage Gateway console, choose Tapes. Verify that your tape's status is ARCHIVED. Restoring Data from a Tape Archived in Backup Exec Restoring your archived data is a two-step process. To restore data from an archived tape 1. Retrieve the archived tape to a Tape Gateway. For instructions, see Retrieving Archived Tapes. 2. Use Backup Exec to restore the data. This process is the same as restoring data from physical tapes. For instructions, see the Backup Exec Administrative Guide in the documentation section in the Backup Exec software. Deactivating a Tape Drive in Backup Exec A Tape Gateway provides 10 tape drives, but you might decide to use fewer tape drives. In that case, you deactivate the tape drives you don't use. 1. Open Backup Exec, and choose the Storage tab. 2. In the Robotic library tree, open the context (right-click) menu for the tape drive you want to deactivate, and then choose Disable. Next Step Cleaning up unecessary resources Testing Your Setup by Using Veritas NetBackup You can back up your data to virtual tapes, archive the tapes, and manage your virtual tape library (VTL) devices by using Veritas NetBackup. In this topic, you can find basic documentation on how Veritas NetBackup API Version 2013-06-30 115 AWS Storage Gateway Tape Gateway User Guide to configure the NetBackup application for a Tape Gateway and perform a backup and restore operation. For detailed information about how to use NetBackup, see the Veritas Services and Operations Readiness Tools (SORT) page on the Veritas website. For more information about compatible backup applications, see Supported third-party backup applications for a Tape Gateway. Topics • Configuring NetBackup Storage Devices • Backing Up Data to a Tape • Archiving the Tape • Restoring Data from the Tape Configuring NetBackup Storage Devices After you have connected the virtual tape library (VTL) devices to the Windows client, you configure Veritas NetBackup storage to recognize your devices. For information about how to connect VTL devices to the Windows client, see Connecting your VTL devices. To configure NetBackup to use storage devices on your Tape Gateway 1. Open the NetBackup Administration Console as an administrator. 2. Choose Configure Storage Devices to open the Device Configuration wizard. 3. Choose Next. The NetBackup application detects your computer as a device host. 4. 5. 6. 7. 8. In the Device Hosts column, select
|
storagegateway-tgw-ug-047
|
storagegateway-tgw-ug.pdf
| 47 |
Tape Configuring NetBackup Storage Devices After you have connected the virtual tape library (VTL) devices to the Windows client, you configure Veritas NetBackup storage to recognize your devices. For information about how to connect VTL devices to the Windows client, see Connecting your VTL devices. To configure NetBackup to use storage devices on your Tape Gateway 1. Open the NetBackup Administration Console as an administrator. 2. Choose Configure Storage Devices to open the Device Configuration wizard. 3. Choose Next. The NetBackup application detects your computer as a device host. 4. 5. 6. 7. 8. In the Device Hosts column, select your computer, and then choose Next. The NetBackup application scans your computer for devices and discovers all devices. In the Scanning Hosts page, choose Next, and then choose Next. The NetBackup application finds all 10 tape drives and the medium changer on your computer. In the Backup Devices window, choose Next. In the Drag and Drop Configuration window, verify that your medium changer is selected, and then choose Next. In the dialog box that appears, choose Yes to save the configuration on your computer. The NetBackup application updates the device configuration. Veritas NetBackup API Version 2013-06-30 116 AWS Storage Gateway Tape Gateway User Guide 9. When the update is completed, choose Next to make the devices available to the NetBackup application. 10. In the Finished! window, choose Finish. To verify your devices in the NetBackup application 1. 2. 3. 4. In the NetBackup Administration Console, expand the Media and Device Management node, and then expand the Devices node. Choose Drives to display all the tape drives. In the Devices node, choose Robots to display all your medium changers. In the NetBackup application, the medium changer is called a robot. In the All Robots pane, open the context (right-click) menu for TLD(0) (that is, your robot), and then choose Inventory Robot. In the Robot Inventory window, verify that your host is selected from the Device-Host list located in the Select robot category. 5. Verify that your robot is selected from the Robot list. 6. In the Robot Inventory window, select Update volume configuration, select Preview changes, select Empty media access port prior to update, and then choose Start. The process then inventories your medium changer and virtual tapes in the NetBackup Enterprise Media Management (EMM) database. NetBackup stores media information, device configuration, and tape status in the EMM. 7. In the Robot Inventory window, choose Yes once the inventory is complete. Choosing Yes here updates the configuration and moves virtual tapes found in import/export slots to the virtual tape library. 8. Close the Robot Inventory window. 9. In the Media node, expand the Robots node and choose TLD(0) to show all virtual tapes that are available to your robot (medium changer). Note If you have previously connected other devices to the NetBackup application, you might have multiple robots. Make sure that you select the right robot. Veritas NetBackup API Version 2013-06-30 117 AWS Storage Gateway Tape Gateway User Guide Now that you have connected your devices and made them available to your backup application, you are ready to test your gateway. To test your gateway, you back up data onto the virtual tapes you created and archive the tapes. Backing Up Data to a Tape You test the Tape Gateway setup by backing up data onto your virtual tapes. Note • You should back up only a small amount of data for this Getting Started exercise, because there are costs associated with storing, archiving, and retrieving data. For pricing information, see Pricing on the Storage Gateway detail page. • If your Tape Gateway restarts for any reason during an ongoing backup job, the backup job will be suspended. The suspended backup job will resume automatically when your gateway finishes restarting. To create a volume pool A volume pool is a collection of virtual tapes to use for a backup. 1. 2. 3. 4. Start the NetBackup Administration Console. Expand the Media node, open the context (right-click) menu for Volume Pool, and then choose New. The New Volume Pool dialog box appears. For Name, type a name for your volume pool. For Description, type a description for the volume pool, and then choose OK. The volume pool you just created is added to the volume pool list. The following screenshot shows a list of volume pools. To add virtual tapes to a volume pool 1. Expand the Robots node, and select the TLD(0) robot to display the virtual tapes this robot is aware of. Veritas NetBackup API Version 2013-06-30 118 AWS Storage Gateway Tape Gateway User Guide If you have previously connected a robot, your Tape Gateway robot might have a different name. 2. 3. 4. From the list of virtual tapes, open the context (right-click) menu for the tape you want
|
storagegateway-tgw-ug-048
|
storagegateway-tgw-ug.pdf
| 48 |
choose OK. The volume pool you just created is added to the volume pool list. The following screenshot shows a list of volume pools. To add virtual tapes to a volume pool 1. Expand the Robots node, and select the TLD(0) robot to display the virtual tapes this robot is aware of. Veritas NetBackup API Version 2013-06-30 118 AWS Storage Gateway Tape Gateway User Guide If you have previously connected a robot, your Tape Gateway robot might have a different name. 2. 3. 4. From the list of virtual tapes, open the context (right-click) menu for the tape you want to add to the volume pool, and choose Change to open the Change Volumes dialog box. For Volume Pool, choose New pool. For New pool, select the pool you just created, and then choose OK. You can verify that your volume pool contains the virtual tape that you just added by expanding the Media node and choosing your volume pool. To create a backup policy The backup policy specifies what data to back up, when to back it up, and which volume pool to use. 1. Choose your Master Server to return to the Veritas NetBackup console. 2. Choose Create a Policy to open the Policy Configuration Wizard window. 3. 4. Select File systems, databases, applications, and choose Next. For Policy Name, type a name for your policy and verify that MS-Windows is selected from the Select the policy type list, and then choose Next. 5. In the Client List window, choose Add, type the host name of your computer in the Name column, and then choose Next. This step applies the policy you are defining to localhost (your client computer). 6. 7. In the Files window, choose Add, and then choose the folder icon. In the Browse window, browse to the folder or files you want to back up, choose OK, and then choose Next. 8. In the Backup Types window, accept the defaults, and then choose Next. Note If you want to initiate the backup yourself, select User Backup. 9. In the Frequency and Retention window, select the frequency and retention policy you want to apply to the backup. For this exercise, you can accept all of the defaults and choose Next. Veritas NetBackup API Version 2013-06-30 119 AWS Storage Gateway Tape Gateway User Guide 10. In the Start window, select Off hours, and then choose Next. This selection specifies that your folder should be backed up during off hours only. 11. In the Policy Configuration wizard, choose Finish. The policy runs the backups according to the schedule. You can also perform a manual backup at any time, which we do in the next step. To perform a manual backup 1. On the navigation pane of the NetBackup console, expand the NetBackup Management node. 2. Expand the Policies node. 3. Open the context (right-click) menu for your policy, and choose Manual Backup. 4. 5. In the Manual Backup window, select a schedule, select a client, and then choose OK. In the Manual Backup Started dialog box that appears, choose OK. 6. On the navigation pane, choose Activity Monitor to view the status of your backup in the Job ID column. To find the barcode of the virtual tape where NetBackup wrote the file data during the backup, look in the Job Details window as described in the following procedure. You need this barcode in the procedure in the next section, where you archive the tape. To find the barcode of a tape 1. 2. 3. In Activity Monitor, open the context (right-click) menu for the identifier of your backup job in the Job ID column, and then choose Details. In the Job Details window, choose the Detailed Status tab. In the Status box, locate the media ID. For example, an entry in the status report might read media id 87A222. This ID helps you determine which tape you have written data to. You have now successfully deployed a Tape Gateway, created virtual tapes, and backed up your data. Next, you can archive the virtual tapes and retrieve them from the archive. Veritas NetBackup API Version 2013-06-30 120 AWS Storage Gateway Archiving the Tape Tape Gateway User Guide When you archive a tape, Tape Gateway moves the tape from your gateway’s virtual tape library (VTL) to the archive, which provides offline storage. You initiate tape archival by ejecting the tape using your backup application. To archive a virtual tape 1. In the NetBackup Administration console, expand the Media and Device Management node, and expand the Media node. 2. Expand Robots and choose TLD(0). 3. Open the context (right-click) menu for the virtual tape you want to archive, and choose Eject Volume From Robot. 4. In the Eject Volumes window, make sure the Media ID matches the virtual tape you
|
storagegateway-tgw-ug-049
|
storagegateway-tgw-ug.pdf
| 49 |
you archive a tape, Tape Gateway moves the tape from your gateway’s virtual tape library (VTL) to the archive, which provides offline storage. You initiate tape archival by ejecting the tape using your backup application. To archive a virtual tape 1. In the NetBackup Administration console, expand the Media and Device Management node, and expand the Media node. 2. Expand Robots and choose TLD(0). 3. Open the context (right-click) menu for the virtual tape you want to archive, and choose Eject Volume From Robot. 4. In the Eject Volumes window, make sure the Media ID matches the virtual tape you want to eject, and then choose Eject. 5. In the dialog box, choose Yes. When the eject process is completed, the status of the tape in the Eject Volumes dialog box indicates that the eject succeeded. 6. Choose Close to close the Eject Volumes window. 7. In the Storage Gateway console, verify the status of the tape you are archiving in the gateway's VTL. It can take some time to finish uploading data to AWS. During this time, the ejected tape is listed in the gateway's VTL with the status IN TRANSIT TO VTS. When archiving starts, the status is ARCHIVING. Once data upload has completed, the ejected tape is no longer listed in the VTL but is archived in S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive. 8. 9. To verify that the virtual tape is no longer listed in your gateway, choose your gateway, and then choose VTL Tape Cartridges. In the navigation pane of the Storage Gateway console, choose Tapes. Verify that your archived tape's status is ARCHIVED. Restoring Data from the Tape Restoring your archived data is a two-step process. To restore data from an archived tape 1. Retrieve the archived tape to a Tape Gateway. For instructions, see Retrieving Archived Tapes. Veritas NetBackup API Version 2013-06-30 121 AWS Storage Gateway Tape Gateway User Guide 2. Use the Backup, Archive, and Restore software installed with the Veritas NetBackup application. This process is the same as restoring data from physical tapes. For instructions, see Veritas Services and Operations Readiness Tools (SORT) on the Veritas website. Next Step Cleaning up unecessary resources Where do I go from here? After your Tape Gateway is in production, you can perform several maintenance tasks, such as adding and removing tapes, monitoring and optimizing gateway performance, and troubleshooting. For general information about these management tasks, see Managing your Tape Gateway. You can perform some of the Tape Gateway maintenance tasks on the AWS Management Console, such as configuring your gateway's bandwidth rate limits and managing gateway software updates. If your Tape Gateway is deployed on-premises, you can perform some maintenance tasks on the gateway's local console. These include routing your Tape Gateway through a proxy and configuring your gateway to use a static IP address. If you are running your gateway as an Amazon EC2 instance, you can perform specific maintenance tasks on the Amazon EC2 console, such as adding and removing Amazon EBS volumes. For more information on maintaining your Tape Gateway, see Managing your Tape Gateway. If you plan to deploy your gateway in production, you should take your real workload into consideration in determining the disk sizes. For information on how to determine real-world disk sizes, see Managing local disks for your Storage Gateway. Also, consider cleaning up if you don't plan to continue using your Tape Gateway. Cleaning up lets you avoid incurring charges. For information on cleanup, see Cleaning up unecessary resources. Activating your gateway in a virtual private cloud You can create a private connection between your on-premises gateway appliance and cloud- based storage infrastructure. You can use this connection to activate your gateway and allow it to transfer data to AWS storage services without communicating over the public internet. Using the Amazon VPC service, you can launch AWS resources, including private network interface endpoints, in a custom virtual private cloud (VPC). A VPC gives you control over network settings such as IP Where do I go from here? API Version 2013-06-30 122 AWS Storage Gateway Tape Gateway User Guide address range, subnets, route tables, and network gateways. For more information about VPCs, see What is Amazon VPC? in the Amazon VPC User Guide. To activate your gateway in a VPC, use the Amazon VPC Console to create a VPC endpoint for Storage Gateway and get the VPC endpoint ID, then specify this VPC endpoint ID when you create and activate the gateway. For more information, see Connect your Tape Gateway to AWS. Note You must activate your gateway in the same region where you create the VPC endpoint for Storage Gateway Topics • Creating a VPC endpoint for Storage Gateway Creating a VPC endpoint for Storage Gateway Follow these instructions to create a VPC
|
storagegateway-tgw-ug-050
|
storagegateway-tgw-ug.pdf
| 50 |
is Amazon VPC? in the Amazon VPC User Guide. To activate your gateway in a VPC, use the Amazon VPC Console to create a VPC endpoint for Storage Gateway and get the VPC endpoint ID, then specify this VPC endpoint ID when you create and activate the gateway. For more information, see Connect your Tape Gateway to AWS. Note You must activate your gateway in the same region where you create the VPC endpoint for Storage Gateway Topics • Creating a VPC endpoint for Storage Gateway Creating a VPC endpoint for Storage Gateway Follow these instructions to create a VPC endpoint. If you already have a VPC endpoint for Storage Gateway, you can use it to activate your gateway. To create a VPC endpoint for Storage Gateway 1. Sign in to the AWS Management Console and open the Amazon VPC console at https:// console.aws.amazon.com/vpc/. 2. In the navigation pane, choose Endpoints, and then choose Create Endpoint. 3. On the Create Endpoint page, choose AWS Services for Service category. 4. For Service Name, choose com.amazonaws.region.storagegateway. For example com.amazonaws.us-east-2.storagegateway. 5. For VPC, choose your VPC and note its Availability Zones and subnets. 6. Verify that Enable Private DNS Name is not selected. 7. For Security group, choose the security group that you want to use for your VPC. You can accept the default security group. Verify that all of the following TCP ports are allowed in your security group: • TCP 443 Creating a VPC endpoint for Storage Gateway API Version 2013-06-30 123 AWS Storage Gateway Tape Gateway User Guide • TCP 1026 • TCP 1027 • TCP 1028 • TCP 1031 • TCP 2222 8. Choose Create endpoint. The initial state of the endpoint is pending. When the endpoint is created, note the ID of the VPC endpoint that you just created. 9. When the endpoint is created, choose Endpoints, then choose the new VPC endpoint. 10. In Details tab of the selected storage gateway endpoint, under DNS Names, use the first DNS name that doesn't specify an Availability Zone. Your DNS name look similar to this: vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com Now that you have a VPC endpoint, you can create your gateway. For more information, see Creating a Gateway. Creating a VPC endpoint for Storage Gateway API Version 2013-06-30 124 AWS Storage Gateway Tape Gateway User Guide Managing your Tape Gateway Managing your gateway includes tasks such as configuring cache storage and upload buffer space, working with virtual tapes, and doing general maintenance. If you haven't created a gateway, see Getting started with AWS Storage Gateway. Following, you can find information about how to manage your Tape Gateway resources. Topics • Editing Basic Gateway Information - Learn how to use the Storage Gateway console to edit basic information for an existing gateway, including the gateway name, time zone, and CloudWatch log group. • Managing Automatic Tape Creation - Learn how to configure Tape Gateway to create new virtual tapes automatically to maintain the minimum number of available tapes that you specify. • Archiving Virtual Tapes - Learn how to configure archival of your tapes to either the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage class when you create a new tape. • Moving tapes to S3 Glacier Deep Archive storage class - Learn how to move your tapes from S3 Glacier Flexible Retrieval to S3 Glacier Deep Archive for long-term data retention and digital preservation at a very low cost. • Retrieving Archived Tapes - Learn how to access data stored on an archived virtual tape by first retrieving the tape to your Tape Gateway. • Viewing tape usage statistics - Learn how to view the amount of data stored on a tape using the Storage Gateway console. • Deleting virtual tapes from your Tape Gateway - Learn how to delete virtual tapes from your Tape Gateway by using the Storage Gateway console. • Deleting Custom Tape Pools - Learn how to delete a custom tape pool using the Storage Gateway console. • Deactivating Your Tape Gateway - Learn how to deactivate a Tape Gateway if the gateway has failed and you want to recover the tapes from the failed gateway to another gateway. • Understanding Tape Status - Learn about the various tape status values that Storage Gateway reports to help determine whether a tape is functioning normally, or if there is a problem that might require action on your part. • Moving your data to a new gateway - Learn how to move data between gateways as your data and performance needs grow, or if you receive an AWS notification to migrate your gateway. API Version 2013-06-30 125 AWS Storage Gateway Tape Gateway User Guide Editing Basic Gateway Information You can use the Storage Gateway console to edit basic information for an existing gateway, including the gateway
|
storagegateway-tgw-ug-051
|
storagegateway-tgw-ug.pdf
| 51 |
Learn about the various tape status values that Storage Gateway reports to help determine whether a tape is functioning normally, or if there is a problem that might require action on your part. • Moving your data to a new gateway - Learn how to move data between gateways as your data and performance needs grow, or if you receive an AWS notification to migrate your gateway. API Version 2013-06-30 125 AWS Storage Gateway Tape Gateway User Guide Editing Basic Gateway Information You can use the Storage Gateway console to edit basic information for an existing gateway, including the gateway name, time zone, and CloudWatch log group. To edit basic information for an existing gateway 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. Choose Gateways, then choose the gateway for which you want to edit basic information. 3. 4. 5. 6. From the Actions dropdown menu, choose Edit gateway information. For Gateway name, enter a name for your gateway. You can search for this name to find your gateway on the list pages in the Storage Gateway console. Note Gateway names must be between 2 and 255 characters, and cannot include a slash (\ or /). Changing a gateway's name will disconnect any CloudWatch alarms set up to monitor the gateway. To reconnect the alarms, update the GatewayName for each alarm in the CloudWatch console. For Gateway time zone, choose the local time zone for the part of the world where you want to deploy your gateway. For Choose how to set up log group, choose how to set up Amazon CloudWatch Logs to monitor the health of your gateway. You can choose from the following options: • Create a new log group – Set up a new log group to monitor your gateway. • Use an existing log group – Choose an existing log group from the corresponding dropdown list. • Deactivate logging – Do not use Amazon CloudWatch Logs to monitor your gateway. 7. When you finish modifying the settings you want to change, choose Save changes. Editing Gateway Information API Version 2013-06-30 126 AWS Storage Gateway Tape Gateway User Guide Managing Automatic Tape Creation The Tape Gateway automatically creates new virtual tapes to maintain the minimum number of available tapes that you configure. It then makes these new tapes available for import by the backup application so that your backup jobs can run without interruption. Automatic tape creation removes the need for custom scripting in addition to the manual process for creating new virtual tapes. To delete an automatic tape creation policy 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. In the navigation pane, choose the Gateways tab. 3. Choose the gateway for which you need to manage automatic tape creation. 4. 5. In the Actions menu, choose Configure tape auto-create. To delete an automatic tape creation policy on a gateway, choose Remove to the right of the policy you want to delete. To stop automatic tape creation on a gateway, delete all of the automatic tape creation policies for that gateway. Choose Save changes to confirm deletion of tape auto-create policies for the selected Tape Gateway. Note Deleting a tape auto-creation policy from a gateway cannot be undone. To change the automatic tape creation policies for a Tape Gateway 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. In the navigation pane, choose the Gateways tab. 3. Choose the gateway for which you need to manage automatic tape creation. 4. In the Actions menu, choose Configure tape auto-create, and change the settings on the page that appears. Managing Automatic Tape Creation API Version 2013-06-30 127 AWS Storage Gateway Tape Gateway User Guide 5. 6. 7. For Minimum number of tapes, enter the minimum number of virtual tapes that should be available on the Tape Gateway at all times. The valid range for this value is a minimum of 1 and a maximum of 10. For Capacity, enter the size, in bytes of the virtual tape capacity. The valid range for this value is a minimum of 100 GiB and a maximum of 15 TiB. For Barcode prefix, enter the prefix that you want to prepend to the barcode of your virtual tapes. Note Virtual tapes are uniquely identified by a barcode, and you can add a prefix to the barcode. The prefix is optional, but you can use it to help identify your virtual tapes. The prefix must be uppercase letters (A–Z) and must be one to four characters long. 8. For Pool, choose Glacier Pool or Deep Archive Pool. This pool represents the storage class in which your tapes are stored when they are ejected by your backup software. • Choose Glacier Pool if you want to archive the tapes in the S3 Glacier Flexible Retrieval storage class. When your
|
storagegateway-tgw-ug-052
|
storagegateway-tgw-ug.pdf
| 52 |
tapes. Note Virtual tapes are uniquely identified by a barcode, and you can add a prefix to the barcode. The prefix is optional, but you can use it to help identify your virtual tapes. The prefix must be uppercase letters (A–Z) and must be one to four characters long. 8. For Pool, choose Glacier Pool or Deep Archive Pool. This pool represents the storage class in which your tapes are stored when they are ejected by your backup software. • Choose Glacier Pool if you want to archive the tapes in the S3 Glacier Flexible Retrieval storage class. When your backup software ejects the tapes, they are automatically archived in S3 Glacier Flexible Retrieval. You use S3 Glacier Flexible Retrieval for more active archives, where you can retrieve a tape typically within 3-5 hours. For detailed information, see Storage Classes for Archiving Objects in the Amazon Simple Storage Service User Guide. • Choose Deep Archive Pool if you want to archive the tapes in S3 Glacier Deep Archive. When your backup software ejects the tape, the tape is automatically archived in S3 Glacier Deep Archive. You use S3 Glacier Deep Archive for long-term data retention and digital preservation, where data is accessed once or twice a year. You can retrieve a tape archived in S3 Glacier Deep Archive typically within 12 hours. For detailed information, see Storage Classes for Archiving Objects in the Amazon Simple Storage Service User Guide. If you archive tapes in S3 Glacier Flexible Retrieval, you can move them to S3 Glacier Deep Archive later. For more information, see Moving tapes to S3 Glacier Deep Archive storage class. 9. You can find information about your tapes on the Tape overview page. By default, this list displays up to 1,000 tapes at a time, but the searches that you perform apply to all of your tapes. You can use the search bar to find tapes that match a specific criteria, or to reduce the list to less than 1,000 tapes. When your list contains 1,000 tapes or fewer, you can then sort your tapes in ascending or descending order by various properties. Managing Automatic Tape Creation API Version 2013-06-30 128 AWS Storage Gateway Tape Gateway User Guide The status of available virtual tapes is initially set to CREATING when the tapes are being created. After the tapes are created, their status changes to AVAILABLE. For more information, see Understanding Tape Status. For more information about enabling automatic tape creation, see Creating Tapes Automatically. Archiving Virtual Tapes You can archive your tapes to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive. When you create a tape, you choose the archive pool that you want to use to archive your tape. You choose Glacier Pool if you want to archive the tape in S3 Glacier Flexible Retrieval. When your backup software ejects the tape, it is automatically archived in S3 Glacier Flexible Retrieval. You use S3 Glacier Flexible Retrieval for more active archives where the data is regularly retrieved and needed in minutes. For detailed information, see Storage Classes for Archiving Objects You choose Deep Archive Pool if you want to archive the tape in S3 Glacier Deep Archive. When your backup software ejects the tape, the tape is automatically archived in S3 Glacier Deep Archive. You use S3 Glacier Deep Archive for long-term data retention and digital preservation at a very low cost. Data in S3 Glacier Deep Archive is not retrieved often or is rarely retrieved. For detailed information, see Storage Classes for Archiving Objects. Note Any tape created before March 27, 2019, are archived directly in S3 Glacier Flexible Retrieval when your backup software ejects it. When your backup software ejects a tape, it is automatically archived in the pool that you chose when you created the tape. The process for ejecting a tape varies depending on your backup software. Some backup software requires that you export tapes after they are ejected before archiving can begin. For information about supported backup software, see Using Your Backup Software to Test Your Gateway Setup. Moving tapes to S3 Glacier Deep Archive storage class Archiving Tapes API Version 2013-06-30 129 AWS Storage Gateway Tape Gateway User Guide Move your tapes from S3 Glacier Flexible Retrieval to S3 Glacier Deep Archive for long-term data retention and digital preservation at a very low cost. You use S3 Glacier Deep Archive for long-term data retention and digital preservation where the data is accessed once or twice a year. For detailed information, see Storage Classes for Archiving Objects. To move a tape from S3 Glacier Flexible Retrieval to S3 Glacier Deep Archive 1. In the navigation pane, choose Tape Library > Tapes to see your tapes. By default, this list displays up to 1,000 tapes at a time, but the searches that you
|
storagegateway-tgw-ug-053
|
storagegateway-tgw-ug.pdf
| 53 |
tapes from S3 Glacier Flexible Retrieval to S3 Glacier Deep Archive for long-term data retention and digital preservation at a very low cost. You use S3 Glacier Deep Archive for long-term data retention and digital preservation where the data is accessed once or twice a year. For detailed information, see Storage Classes for Archiving Objects. To move a tape from S3 Glacier Flexible Retrieval to S3 Glacier Deep Archive 1. In the navigation pane, choose Tape Library > Tapes to see your tapes. By default, this list displays up to 1,000 tapes at a time, but the searches that you perform apply to all of your tapes. You can use the search bar to find tapes that match a specific criteria, or to reduce the list to less than 1,000 tapes. When your list contains 1,000 tapes or fewer, you can then sort your tapes in ascending or descending order by various properties. 2. Select the check boxes for the tapes you want to move to S3 Glacier Deep Archive. You can see the pool that each tape is associated with in the Pool column. 3. Choose Assign to pool. 4. In the Assign tape to pool dialog box, verify the barcodes for the tapes you are moving and choose Assign. Note If a tape has been ejected by the backup application and archived in S3 Glacier Deep Archive, you can't move it back to S3 Glacier Flexible Retrieval. There's a charge for moving your tapes from S3 Glacier Flexible Retrieval to S3 Glacier Deep Archive. In addition, if you move tapes from S3 Glacier Flexible Retrieval to S3 Glacier Deep Archive prior to 90 days, there is an early deletion fee for S3 Glacier Flexible Retrieval. 5. After the tape is moved, you can see the updated status in the Pool column on the Tape overview page. Retrieving Archived Tapes To access data stored on an archived virtual tape, you must first retrieve the tape that you want to your Tape Gateway. Your Tape Gateway provides one virtual tape library (VTL) for each gateway. If you have more than one Tape Gateway in an AWS Region, you can retrieve a tape to only one gateway. The retrieved tape is write-protected; you can only read the data on the tape. Retrieving Archived Tapes API Version 2013-06-30 130 AWS Storage Gateway Tape Gateway User Guide Important If you archive a tape in S3 Glacier Flexible Retrieval, you can retrieve the tape typically within 3-5 hours. If you archive the tape in S3 Glacier Deep Archive, you can retrieve it typically within 12 hours. Note There is a charge for retrieving tapes from archive. For detailed pricing information, see Storage Gateway Pricing. To retrieve an archived tape to your gateway 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. In the navigation pane, choose Tape Library > Tapes to see your tapes. By default, this list displays up to 1,000 tapes at a time, but the searches that you perform apply to all of your tapes. You can use the search bar to find tapes that match a specific criteria, or to reduce the list to less than 1,000 tapes. When your list contains 1,000 tapes or fewer, you can then sort your tapes in ascending or descending order by various properties. 3. Choose the virtual tape you want to retrieve from the Virtual Tape Shelf tab, and choose Retrieve tape. Note The status of the virtual tape that you want to retrieve must be ARCHIVED. 4. 5. In the Retrieve tape dialog box, for Barcode, verify that the barcode identifies the virtual tape you want to retrieve. For Gateway, choose the gateway that you want to retrieve the archived tape to, and then choose Retrieve tape. The status of the tape changes from ARCHIVED to RETRIEVING. At this point, your data is being moved from the virtual tape shelf (backed by S3 Glacier Flexible Retrieval or S3 Glacier Deep Retrieving Archived Tapes API Version 2013-06-30 131 AWS Storage Gateway Tape Gateway User Guide Archive) to the virtual tape library (backed by Amazon S3). After all the data is moved, the status of the virtual tape in the archive changes to RETRIEVED. Note Retrieved virtual tapes are read-only. Viewing tape usage statistics When you write data to a tape, you can view the amount of data stored on the tape in the Storage Gateway console. The Details tab for each tape shows the tape usage information. To view the amount of data stored on a tape 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. In the navigation pane, choose Tape Library > Tapes to see your tapes. By default, this list displays up to 1,000 tapes at a time, but the searches that you perform apply to all of
|
storagegateway-tgw-ug-054
|
storagegateway-tgw-ug.pdf
| 54 |
RETRIEVED. Note Retrieved virtual tapes are read-only. Viewing tape usage statistics When you write data to a tape, you can view the amount of data stored on the tape in the Storage Gateway console. The Details tab for each tape shows the tape usage information. To view the amount of data stored on a tape 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. In the navigation pane, choose Tape Library > Tapes to see your tapes. By default, this list displays up to 1,000 tapes at a time, but the searches that you perform apply to all of your tapes. You can use the search bar to find tapes that match a specific criteria, or to reduce the list to less than 1,000 tapes. When your list contains 1,000 tapes or fewer, you can then sort your tapes in ascending or descending order by various properties. 3. Choose the tape you are interested in. 4. The page that appears provides various details and information about the tape, including the following: • Size: The total capacity of the selected tape. • Used: The size of data written to the tape by your backup application. Note This value is not available for tapes created before May 13, 2015. Deleting virtual tapes from your Tape Gateway You can delete virtual tapes from your Tape Gateway by using the Storage Gateway console. Viewing tape usage statistics API Version 2013-06-30 132 AWS Storage Gateway Note Tape Gateway User Guide If the tape you want to delete from your Tape Gateway has a status of RETRIEVED, you must first eject the tape using your backup application before deleting the tape. For instructions on how to eject a tape using the Symantec NetBackup software, see Archiving the Tape. After the tape is ejected, the tape status changes back to ARCHIVED. You can then delete the tape. Make copies of your data before you delete your tapes. After you delete a tape, you can't get it back. To delete a virtual tape Warning This procedure permanently deletes the selected virtual tape. 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. In the navigation pane, choose Tape Library > Tapes to see your tapes. By default, this list displays up to 1,000 tapes at a time, but the searches that you perform apply to all of your tapes. You can use the search bar to find tapes that match a specific criteria, or to reduce the list to less than 1,000 tapes. When your list contains 1,000 tapes or fewer, you can then sort your tapes in ascending or descending order by various properties. 3. 4. Select one or more tapes to delete. For Actions choose Delete tape. The confirmation dialog box appears. 5. Verify that you want to delete the specified tapes, then type the word delete in the confirmation box and choose Delete. After the tape is deleted, it disappears from the Tape Gateway. Deleting Tapes API Version 2013-06-30 133 AWS Storage Gateway Tape Gateway User Guide Deleting Custom Tape Pools The following procedure explains how to delete a custom tape pool using the Storage Gateway console. To perform this action programmatically using the API, see DeleteTapePool in the Storage Gateway API Reference. You can delete a custom tape pool only if there are no archived tapes in the pool, and there are no automatic tape creation policies attached to the pool. If you need to delete automatic tape creation policies from a tape pool, see Managing Automatic Tape Creation. To delete a custom tape pool using the Storage Gateway console 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. 3. In the navigation pane, choose Pools to see the available pools. Select one or more tape pools to delete. If the Tape Count for the tape pools that you want to delete is 0, and if there are no automatic tape creation policies that reference the custom tape pool, you can delete the pools. 4. Choose Delete. The confirmation dialog box appears. 5. Verify that you want to delete the specified tape pools, then type the word delete in the confirmation box and choose Delete. Warning This procedure permanently deletes the selected tape pools and can't be undone. After the tape pools are deleted, they disappear from the tape library. Deactivating Your Tape Gateway You deactivate a Tape Gateway if the Tape Gateway has failed and you want to recover the tapes from the failed gateway to another gateway. To recover the tapes, you must first deactivate the failed gateway. Deactivating a Tape Gateway locks down the virtual tapes in that gateway. That is, any data that you might write to these tapes after deactivating the gateway isn't sent to AWS. You can only deactivate a gateway on the Storage Deleting Custom
|
storagegateway-tgw-ug-055
|
storagegateway-tgw-ug.pdf
| 55 |
tape pools and can't be undone. After the tape pools are deleted, they disappear from the tape library. Deactivating Your Tape Gateway You deactivate a Tape Gateway if the Tape Gateway has failed and you want to recover the tapes from the failed gateway to another gateway. To recover the tapes, you must first deactivate the failed gateway. Deactivating a Tape Gateway locks down the virtual tapes in that gateway. That is, any data that you might write to these tapes after deactivating the gateway isn't sent to AWS. You can only deactivate a gateway on the Storage Deleting Custom Tape Pools API Version 2013-06-30 134 AWS Storage Gateway Tape Gateway User Guide Gateway console if the gateway is no longer connected to AWS. If the gateway is connected to AWS, you can't deactivate the Tape Gateway. You deactivate a Tape Gateway as part of data recovery. For more information about recovering tapes, see You Need to Recover a Virtual Tape from a Malfunctioning Tape Gateway. To deactivate your gateway 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. In the navigation pane, choose Gateways, and then choose the failed gateway. 3. Choose the Details tab for the gateway to display the deactivate gateway message. 4. Choose Create recovery tapes. 5. Choose Disable gateway. Understanding Tape Status Each tape has an associated status that tells you at a glance what the health of the tape is. Most of the time, the status indicates that the tape is functioning normally and that no action is needed on your part. In some cases, the status indicates a problem with the tape that might require action on your part. You can find information following to help you decide when you need to act. Topics • Understanding Tape Status Information in a VTL • Determining Tape Status in an Archive Understanding Tape Status Information in a VTL A tape's status must be AVAILABLE for you to read or write to the tape. The following table lists and describes possible status values. Status Description Tape Data Is Stored In CREATING The virtual tape is being created. The tape can't be loaded into a tape drive, because the tape is being — created. Understanding Tape Status API Version 2013-06-30 135 AWS Storage Gateway Tape Gateway User Guide Status Description Tape Data Is Stored In AVAILABLE The virtual tape is created and ready to be loaded into a tape drive. Amazon S3 IN TRANSIT TO VTS The virtual tape has been ejected and is being uploaded for archive. At this point, your Tape Amazon S3 Gateway is uploading data to AWS. If the amount of data being uploaded is small, this status might not appear. When the upload is completed, the status changes to ARCHIVING. ARCHIVING The virtual tape is being moved by your Tape Gateway to the archive, which is backed by S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive. This Data is being moved from Amazon S3 to S3 Glacier Flexible Retrieval process happens after the data upload to AWS is or S3 Glacier Deep completed. Archive. DELETING The virtual tape is being deleted. Data is being deleted from Amazon S3 DELETED The virtual tape has been successfully deleted. — RETRIEVIN G The virtual tape is being retrieved from the archive to your Tape Gateway. Data is being moved from S3 Glacier Flexible Note The virtual tape can be retrieved only to a Tape Gateway. Retrieval or S3 Glacier Deep Archive to Amazon S3 RETRIEVED The virtual tape is retrieved from the archive. The retrieved tape is write-protected. Amazon S3 Understanding Tape Status Information in a VTL API Version 2013-06-30 136 AWS Storage Gateway Tape Gateway User Guide Status Description Tape Data Is Stored In RECOVERED The virtual tape is recovered and is read-only. Amazon S3 When your Tape Gateway is not accessible for any reason, you can recover virtual tapes associated with that Tape Gateway to another Tape Gateway. To recover the virtual tapes, first deactivate the inaccessible Tape Gateway. IRRECOVER ABLE The virtual tape can't be read from or written to. This status indicates an error in your Tape Gateway. Amazon S3 Determining Tape Status in an Archive You can use the following procedure to determine the status of a virtual tape in an archive. To determine the status of a virtual tape 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ 2. 3. home. In the navigation pane, choose Tapes. In the Status column of the tape library grid, check the status of the tape. The tape status also appears in the Details tab of each virtual tape. Following, you can find a description of the possible status values. Status Description ARCHIVED The virtual tape has been ejected and is uploaded to the archive. RETRIEVING The virtual tape is being retrieved
|
storagegateway-tgw-ug-056
|
storagegateway-tgw-ug.pdf
| 56 |
the following procedure to determine the status of a virtual tape in an archive. To determine the status of a virtual tape 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ 2. 3. home. In the navigation pane, choose Tapes. In the Status column of the tape library grid, check the status of the tape. The tape status also appears in the Details tab of each virtual tape. Following, you can find a description of the possible status values. Status Description ARCHIVED The virtual tape has been ejected and is uploaded to the archive. RETRIEVING The virtual tape is being retrieved from the archive. Note The virtual tape can be retrieved only to a Tape Gateway. Determining Tape Status in an Archive API Version 2013-06-30 137 AWS Storage Gateway Tape Gateway User Guide Status Description RETRIEVED The virtual tape has been retrieved from the archive. The retrieved tape is read-only. For additional information about how to work with tapes and VTL devices, see Managing tapes in your virtual tape library. Moving your data to a new gateway You can move data between gateways as your data and performance needs grow, or if you receive an AWS notification to migrate your gateway. The following are some reasons for doing this: • Move your data to better host platforms or newer Amazon EC2 instances. • Refresh the underlying hardware for your server. The steps that you follow to move your data to a new gateway depend on the gateway type that you have. Note Data can only be moved between the same gateway types. Moving virtual tapes to a new Tape Gateway To move your virtual tape to a new Tape Gateway 1. Use your backup application to back up all your data onto a virtual tape. Wait for the backup to finish successfully. 2. Use your backup application to eject your tape. The tape will be stored in one of the Amazon S3 storage classes. Ejected tapes are archived in S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive, and are read-only. Before proceeding, confirm that the ejected tapes have been archived: Moving your data to a new gateway API Version 2013-06-30 138 AWS Storage Gateway Tape Gateway User Guide a. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. b. In the navigation pane, choose Tape Library > Tapes to see your tapes. By default, this list displays up to 1,000 tapes at a time, but the searches that you perform apply to all of your tapes. You can use the search bar to find tapes that match a specific criteria, or to reduce the list to less than 1,000 tapes. When your list contains 1,000 tapes or fewer, you can then sort your tapes in ascending or descending order by various properties. c. In the Status column of the list, check the status of the tape. The tape status also appears in the Details tab of each virtual tape. For more information about determining tape status in an archive, see Determining Tape Status in an Archive. 3. Using your backup application, verify that there are no active backup jobs going to the existing Tape Gateway before you stop it. If there are any active backup jobs, wait for them to finish and eject your tapes (see previous step) before stopping the gateway. 4. Use the following steps to stop the existing Tape Gateway: a. b. In the navigation pane, choose Gateways, and then choose the old Tape Gateway that you want to stop. The status of the gateway is Running. For Actions, choose Stop gateway. Verify the ID of the gateway from the dialog box, and then choose Stop gateway. While the old Tape Gateway is stopping, you might see a message that indicates the status of the gateway. When the gateway shuts down, a message and a Start gateway button appear in the Details tab. For more information about stopping a gateway, see Starting and Stopping a Tape Gateway. 5. Create a new Tape Gateway. For detailed instructions, see Creating a Gateway. 6. Use the following steps to create new tapes: a. In the navigation pane, choose the Gateways tab. b. Choose Create tape to open the Create tape dialog box. c. For Gateway, choose a gateway. The tape is created for this gateway. Moving virtual tapes to a new Tape Gateway API Version 2013-06-30 139 AWS Storage Gateway Tape Gateway User Guide d. For Number of tapes, choose the number of tapes that you want to create. For more information about tape limits, see AWS Storage Gateway quotas. You can also set up automatic tape creation at this point. For more information, see Creating Tapes Automatically. For Capacity, enter the size of the virtual tape that you want to create. Tapes must be larger than 100 GiB. For information
|
storagegateway-tgw-ug-057
|
storagegateway-tgw-ug.pdf
| 57 |
box. c. For Gateway, choose a gateway. The tape is created for this gateway. Moving virtual tapes to a new Tape Gateway API Version 2013-06-30 139 AWS Storage Gateway Tape Gateway User Guide d. For Number of tapes, choose the number of tapes that you want to create. For more information about tape limits, see AWS Storage Gateway quotas. You can also set up automatic tape creation at this point. For more information, see Creating Tapes Automatically. For Capacity, enter the size of the virtual tape that you want to create. Tapes must be larger than 100 GiB. For information about capacity limits, see AWS Storage Gateway quotas. For Barcode prefix, enter the prefix that you want to prepend to the barcode of your virtual tapes. e. f. Note Virtual tapes are uniquely identified by a barcode. You can add a prefix to the barcode. The prefix is optional, but you can use it to help identify your virtual tapes. The prefix must be uppercase letters (A–Z) and must be one to four characters long. g. For Pool, choose Glacier Pool or Deep Archive Pool. This pool represents the storage class in which your tape will be stored when it is ejected by your backup software. Choose Glacier Pool if you want to archive the tape in S3 Glacier Flexible Retrieval. When your backup software ejects the tape, it is automatically archived in S3 Glacier Flexible Retrieval. You use S3 Glacier Flexible Retrieval for more active archives where you can retrieve a tape typically within 3-5 hours. For more information, see Storage classes for archiving objects in the Amazon Simple Storage Service User Guide. Choose Deep Archive Pool if you want to archive the tape in S3 Glacier Deep Archive. When your backup software ejects the tape, the tape is automatically archived in S3 Glacier Deep Archive. You use S3 Glacier Deep Archive for long-term data retention and digital preservation where data is accessed once or twice a year. You can retrieve a tape archived in S3 Glacier Deep Archive typically within 12 hours. For more information, see Storage classes for archiving objects in the Amazon Simple Storage Service User Guide. If you archive a tape in S3 Glacier Flexible Retrieval, you can move it to S3 Glacier Deep Archive later. For more information, see Moving tapes to S3 Glacier Deep Archive storage class. Moving virtual tapes to a new Tape Gateway API Version 2013-06-30 140 AWS Storage Gateway Tape Gateway User Guide Note Tapes created before March 27, 2019, are archived directly in S3 Glacier Flexible Retrieval when your backup software ejects them. h. (Optional) For Tags, enter a key and value to add tags to your tape. A tag is a case- sensitive key-value pair that helps you manage, filter, and search for your tapes. i. Choose Create tapes. 7. Use your backup application to start a backup job, and back up your data to the new tape. 8. (Optional) If your tape is archived and you need to restore data from it, retrieve it to the new Tape Gateway. The tape will be in read-only mode. For more information about retrieving archived tapes, see Retrieving Archived Tapes. Note Outbound data charges might apply. a. In the navigation pane, choose Tape Library > Tapes to see your tapes. By default, this list displays up to 1,000 tapes at a time, but the searches that you perform apply to all of your tapes. You can use the search bar to find tapes that match a specific criteria, or to reduce the list to less than 1,000 tapes. When your list contains 1,000 tapes or fewer, you can then sort your tapes in ascending or descending order by various properties. b. Choose the virtual tape that you want to retrieve. For Actions, choose Retrieve Tape. Note The status of the virtual tape that you want to retrieve must be ARCHIVED. c. d. In the Retrieve tape dialog box, for Barcode, verify that the barcode identifies the virtual tape you want to retrieve. For Gateway, choose the new Tape Gateway that you want to retrieve the archived tape to, and then choose Retrieve tape. Moving virtual tapes to a new Tape Gateway API Version 2013-06-30 141 AWS Storage Gateway Tape Gateway User Guide When you have confirmed that your new Tape Gateway is working correctly, you can delete the old Tape Gateway. Important Before you delete a gateway, be sure that there are no applications currently writing to that gateway's volumes. If you delete a gateway while it is in use, data loss can occur. 9. Use the following steps to delete the old Tape Gateway: Warning When a gateway is deleted, there is no way to recover it. a. In the navigation pane, choose Gateways, and then choose the gateway
|
storagegateway-tgw-ug-058
|
storagegateway-tgw-ug.pdf
| 58 |
Gateway API Version 2013-06-30 141 AWS Storage Gateway Tape Gateway User Guide When you have confirmed that your new Tape Gateway is working correctly, you can delete the old Tape Gateway. Important Before you delete a gateway, be sure that there are no applications currently writing to that gateway's volumes. If you delete a gateway while it is in use, data loss can occur. 9. Use the following steps to delete the old Tape Gateway: Warning When a gateway is deleted, there is no way to recover it. a. In the navigation pane, choose Gateways, and then choose the gateway that you want to delete. b. For Actions, choose Delete gateway. In the confirmation dialog box that appears, make sure that the gateway ID listed specifies the old Tape Gateway that you want to delete, enter delete in the confirmation field, and then choose Delete. c. Delete the VM. For more information about deleting a VM, see the documentation for your hypervisor. Moving virtual tapes to a new Tape Gateway API Version 2013-06-30 142 AWS Storage Gateway Tape Gateway User Guide Monitoring Storage Gateway This section describes how to monitor a Storage Gateway, including monitoring resources associated with the gateway, using Amazon CloudWatch. You can monitor the gateway's upload buffer and cache storage. You use the Storage Gateway console to view metrics and alarms for your gateway. For example, you can view the number of bytes used in read and write operations, the time spent in read and write operations, and the time taken to retrieve data from the Amazon Web Services Cloud. With metrics, you can track the health of your gateway and set up alarms to notify you when one or more metrics fall outside a defined threshold. Storage Gateway provides CloudWatch metrics at no additional charge. Storage Gateway metrics are recorded for a period of two weeks. By using these metrics, you can access historical information and get a better perspective on how your gateway and volumes are performing. Storage Gateway also provides CloudWatch alarms, except high-resolution alarms, at no additional charge. For more information about CloudWatch pricing, see Amazon CloudWatch pricing. For more information about CloudWatch, see Amazon CloudWatch User Guide. For information specific to monitoring a Tape Gateway and its associated resources, see Monitoring your Tape Gateway. Topics • Understanding gateway metrics • Monitoring the upload buffer • Monitoring cache storage • Understanding CloudWatch alarms • Creating recommended CloudWatch alarms for your gateway • Creating a custom CloudWatch alarm for your gateway • Monitoring Your Tape Gateway Understanding gateway metrics For the discussion in this topic, we define gateway metrics as metrics that are scoped to the gateway—that is, they measure something about the gateway. Because a gateway contains one or more volumes, a gateway-specific metric is representative of all volumes on the gateway. For Understanding gateway metrics API Version 2013-06-30 143 AWS Storage Gateway Tape Gateway User Guide example, the CloudBytesUploaded metric is the total number of bytes that the gateway sent to the cloud during the reporting period. This metric includes the activity of all the volumes on the gateway. When working with gateway metric data, you specify the unique identification of the gateway that you are interested in viewing metrics for. To do this, you specify both the GatewayId and the GatewayName values. When you want to work with metric for a gateway, you specify the gateway dimension in the metrics namespace, which distinguishes a gateway-specific metric from a volume- specific metric. For more information, see Using Amazon CloudWatch Metrics. Note Some metrics return data points only when new data has been generated during the most recent monitoring period. Metric Description AvailabilityNotifi cations Number of availability-related health notifications generated by the gateway. Use this metric with the Sum statistic to observe whether the gateway is experienc ing any availability-related events. For details about the events, check your configured CloudWatch log group. Unit: Number Percent of application reads served from the cache. The sample is taken at the end of the reporting period. Unit: Percent CacheHitPercent Understanding gateway metrics API Version 2013-06-30 144 AWS Storage Gateway Tape Gateway User Guide Metric Description CachePercentDirty CacheUsed IoWaitPercent MemTotalBytes MemUsedBytes The overall percentage of the gateway cache that has not been persisted to AWS. The sample is taken at the end of the reporting period. Use this metric with the Sum statistic. Ideally, this metric should remain low. Unit: Percent The total number of bytes being used in the gateway's cache storage. The sample is taken at the end of the reporting period. Unit: Bytes Percent of time that the gateway is waiting on a response from the local disk. Unit: Percent Amount of RAM provisioned to the gateway VM, in bytes. Unit: Bytes Amount of RAM currently in use by the gateway VM, in bytes.
|
storagegateway-tgw-ug-059
|
storagegateway-tgw-ug.pdf
| 59 |
cache that has not been persisted to AWS. The sample is taken at the end of the reporting period. Use this metric with the Sum statistic. Ideally, this metric should remain low. Unit: Percent The total number of bytes being used in the gateway's cache storage. The sample is taken at the end of the reporting period. Unit: Bytes Percent of time that the gateway is waiting on a response from the local disk. Unit: Percent Amount of RAM provisioned to the gateway VM, in bytes. Unit: Bytes Amount of RAM currently in use by the gateway VM, in bytes. Unit: Bytes Understanding gateway metrics API Version 2013-06-30 145 AWS Storage Gateway Tape Gateway User Guide Metric Description QueuedWrites TotalCacheSize UploadBufferPercen tUsed UploadBufferUsed UserCpuPercent The number of bytes waiting to be written to AWS, sampled at the end of the reporting period for all volumes in the gateway. These bytes are kept in your gateway's working storage. Unit: Bytes The total size of the cache in bytes. The sample is taken at the end of the reporting period. Unit: Bytes Percent use of the gateway's upload buffer. The sample is taken at the end of the reporting period. Unit: Percent The total number of bytes being used in the gateway's upload buffer. The sample is taken at the end of the reporting period. Unit: Bytes Percent of CPU time spent on gateway processing, averaged across all cores. Unit: Percent Understanding gateway metrics API Version 2013-06-30 146 AWS Storage Gateway Tape Gateway User Guide Dimensions for Storage Gateway metrics The CloudWatch namespace for the Storage Gateway service is AWS/StorageGateway. Data is available automatically in 5-minute periods at no charge. Dimension Description GatewayId , GatewayNa me These dimensions filter the data that you request to gateway- specific metrics. You can identify a gateway to work by the value for GatewayId or GatewayName . If the name of your gateway was different for the time range that you are intereste d in viewing metrics, use the GatewayId . Throughput and latency data of a gateway is based on all the volumes for the gateway. For information about working with gateway metrics, see Measuring Performance Between Your Gateway and AWS. Monitoring the upload buffer You can find information following about how to monitor a gateway's upload buffer and how to create an alarm so that you get a notification when the buffer exceeds a specified threshold. By using this approach, you can add buffer storage to a gateway before it fills completely and your storage application stops backing up to AWS. You monitor the upload buffer in the same way in both the cached-volume and Tape Gateway architectures. For more information, see How Tape Gateway works. Note The WorkingStoragePercentUsed, WorkingStorageUsed, and WorkingStorageFree metrics represent the upload buffer for stored volumes only before the release of the cached-volume feature in Storage Gateway. Now, use the equivalent upload buffer metrics UploadBufferPercentUsed, UploadBufferUsed, and UploadBufferFree. These metrics apply to both gateway architectures. Dimensions for Storage Gateway metrics API Version 2013-06-30 147 AWS Storage Gateway Tape Gateway User Guide Item of Interest How to Measure Upload buffer usage Use the UploadBufferPercentUsed UploadBufferFree metrics with the Average statistic. For example, use the UploadBufferUsed with the Average statistic to analyze the storage usage over a time period. , UploadBufferUsed , and To measure the percent of the upload buffer that is used 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. Choose the StorageGateway: Gateway Metrics dimension, and find the gateway that you want to work with. 3. Choose the UploadBufferPercentUsed metric. 4. For Time Range, choose a value. 5. Choose the Average statistic. 6. For Period, choose a value of 5 minutes to match the default reporting time. The resulting time-ordered set of data points contains the percent used of the upload buffer. Using the following procedure, you can create an alarm using the CloudWatch console. To learn more about alarms and thresholds, see Creating CloudWatch Alarms in the Amazon CloudWatch User Guide. To set an upper threshold alarm for a gateway's upload buffer 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. Choose Create Alarm to start the Create Alarm wizard. 3. Specify a metric for your alarm: a. On the Select Metric page of the Create Alarm wizard, choose the AWS/ StorageGateway:GatewayId,GatewayName dimension, and then find the gateway that you want to work with. b. Choose the UploadBufferPercentUsed metric. Use the Average statistic and a period of 5 minutes. c. Choose Continue. Monitoring the upload buffer API Version 2013-06-30 148 AWS Storage Gateway Tape Gateway User Guide 4. Define the alarm name, description, and threshold: a. On the Define Alarm page of the Create Alarm wizard, identify your alarm by giving it a name and description in the Name and Description boxes. b. Define the alarm threshold. c. Choose
|
storagegateway-tgw-ug-060
|
storagegateway-tgw-ug.pdf
| 60 |
the Select Metric page of the Create Alarm wizard, choose the AWS/ StorageGateway:GatewayId,GatewayName dimension, and then find the gateway that you want to work with. b. Choose the UploadBufferPercentUsed metric. Use the Average statistic and a period of 5 minutes. c. Choose Continue. Monitoring the upload buffer API Version 2013-06-30 148 AWS Storage Gateway Tape Gateway User Guide 4. Define the alarm name, description, and threshold: a. On the Define Alarm page of the Create Alarm wizard, identify your alarm by giving it a name and description in the Name and Description boxes. b. Define the alarm threshold. c. Choose Continue. 5. Configure an email action for the alarm: a. On the Configure Actions page of the Create Alarm wizard, choose Alarm for Alarm State. b. Choose Choose or create email topic for Topic. To create an email topic means that you set up an Amazon SNS topic. For more information about Amazon SNS, see Set Up Amazon SNS in the Amazon CloudWatch User Guide. c. For Topic, enter a descriptive name for the topic. d. Choose Add Action. e. Choose Continue. 6. Review the alarm settings, and then create the alarm: a. On the Review page of the Create Alarm wizard, review the alarm definition, metric, and associated actions to take (for example, sending an email notification). b. After reviewing the alarm summary, choose Save Alarm. 7. Confirm your subscription to the alarm topic: a. Open the Amazon SNS email that was sent to the email address that you specified when creating the topic. b. Confirm your subscription by clicking the link in the email. A subscription confirmation appears. Monitoring the upload buffer API Version 2013-06-30 149 AWS Storage Gateway Tape Gateway User Guide Monitoring cache storage You can find information following about how to monitor a gateway's cache storage and how to create an alarm so that you get a notification when parameters of the cache pass specified thresholds. Using this alarm, you know when to add cache storage to a gateway. You only monitor cache storage in the cached volumes architecture. For more information, see How Tape Gateway works. Item of Interest How to Measure Total usage of cache Use the CachePercentUsed and TotalCacheSize metrics with the Average statistic. For example, use the CachePercentUsed with the Average statistic to analyze the cache usage over a period of time. The TotalCacheSize metric changes only when you add cache to the gateway. Use the CacheHitPercent metric with the Average statistic. Typically, you want CacheHitPercent to remain high. Use the CachePercentDirty metrics with the Average statistic. Typically, you want CachePercentDirty to remain low. Percent of read requests that are served from the cache Percent of the cache that is dirty—that is, it contains content that has not been uploaded to AWS To measure the percent of a cache that is dirty for a gateway and all its volumes 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. Choose the StorageGateway: Gateway Metrics dimension, and find the gateway that you want to work with. 3. Choose the CachePercentDirty metric. 4. For Time Range, choose a value. 5. Choose the Average statistic. Monitoring cache storage API Version 2013-06-30 150 AWS Storage Gateway Tape Gateway User Guide 6. For Period, choose a value of 5 minutes to match the default reporting time. The resulting time-ordered set of data points contains the percentage of the cache that is dirty over the 5 minutes. To measure the percent of the cache that is dirty for a volume 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. Choose the StorageGateway: Volume Metrics dimension, and find the volume that you want to work with. 3. Choose the CachePercentDirty metric. 4. For Time Range, choose a value. 5. Choose the Average statistic. 6. For Period, choose a value of 5 minutes to match the default reporting time. The resulting time-ordered set of data points contains the percentage of the cache that is dirty over the 5 minutes. Understanding CloudWatch alarms CloudWatch alarms monitor information about your gateway based on metrics and expressions. You can add CloudWatch alarms for your gateway and view their statuses in the Storage Gateway console. For more information about the metrics that are used to monitor Tape Gateway, see Understanding gateway metrics and Understanding Virtual Tape Metrics. For each alarm, you specify conditions that will initiate its ALARM state. Alarm status indicators in the Storage Gateway console turn red when in the ALARM state, making it easier for you to monitor status proactively. You can configure alarms to invoke actions automatically based on sustained changes in state. For more information about CloudWatch alarms, see Using Amazon CloudWatch alarms in the Amazon CloudWatch User Guide. Note If you don't have permission to view CloudWatch, you can't view the alarms. For each activated gateway, we recommend that you
|
storagegateway-tgw-ug-061
|
storagegateway-tgw-ug.pdf
| 61 |
Tape Gateway, see Understanding gateway metrics and Understanding Virtual Tape Metrics. For each alarm, you specify conditions that will initiate its ALARM state. Alarm status indicators in the Storage Gateway console turn red when in the ALARM state, making it easier for you to monitor status proactively. You can configure alarms to invoke actions automatically based on sustained changes in state. For more information about CloudWatch alarms, see Using Amazon CloudWatch alarms in the Amazon CloudWatch User Guide. Note If you don't have permission to view CloudWatch, you can't view the alarms. For each activated gateway, we recommend that you create the following CloudWatch alarms: Understanding CloudWatch alarms API Version 2013-06-30 151 AWS Storage Gateway Tape Gateway User Guide • High IO wait: IoWaitpercent >= 20 for 3 datapoints in 15 minutes • Cache percent dirty: CachePercentDirty > 80 for 4 datapoints within 20 minutes • Health notifications: HealthNotifications >= 1 for 1 datapoint within 5 minutes. When configuring this alarm, set Missing data treatment to notBreaching. Note You can set a health notification alarm only if the gateway had a previous health notification in CloudWatch. For gateways on VMware host platforms with HA mode activated, we also recommend this additional CloudWatch alarm: • Availability notifications: AvailabilityNotifications >= 1 for 1 datapoint within 5 minutes. When configuring this alarm, set Missing data treatment to notBreaching. The following table describes the state of an alarm. State OK Alarm Insufficient data None Description The metric or expression is within the defined threshold. The metric or expression is outside of the defined threshold. The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state. No alarms are created for the gateway. To create a new alarm, see Creating a custom CloudWatch alarm for your gateway. Understanding CloudWatch alarms API Version 2013-06-30 152 AWS Storage Gateway State Unavailable Tape Gateway User Guide Description The state of the alarm is unknown. Choose Unavailable to view error information in the Monitoring tab. Creating recommended CloudWatch alarms for your gateway When you create a new gateway using the Storage Gateway console, you can choose to create all recommended CloudWatch alarms automatically as part of the initial setup process. For more information, see Configure your Tape Gateway. If you want to add or update recommended CloudWatch alarms for an existing gateway, use the following procedure. To add or update recommended CloudWatch alarms for an existing gateway Note This feature requires CloudWatch policy permissions, which are not automatically granted as part of the preconfigured Storage Gateway full access policy. Make sure your security policy grants the following permissions before you attempt to create recommended CloudWatch alarms: • cloudwatch:PutMetricAlarm - create alarms • cloudwatch:DisableAlarmActions - turn alarm actions off • cloudwatch:EnableAlarmActions - turn alarm actions on • cloudwatch:DeleteAlarms - delete alarms 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home/. 2. In the navigation pane, choose Gateways, then choose the gateway for which you want to create recommended CloudWatch alarms. 3. On the gateway details page, choose the Monitoring tab. 4. Under Alarms, choose Create recommended alarms. The recommended alarms are created automatically. Creating recommended CloudWatch alarms API Version 2013-06-30 153 AWS Storage Gateway Tape Gateway User Guide The Alarms section lists all CloudWatch alarms for a specific gateway. From here, you can select and delete one or more alarms, turn alarm actions on or off, and create new alarms. Creating a custom CloudWatch alarm for your gateway CloudWatch uses Amazon Simple Notification Service (Amazon SNS) to send alarm notifications when an alarm changes state. An alarm watches a single metric over a time period that you specify, and performs one or more actions based on the value of the metric relative to a given threshold over a number of time periods. The action is a notification that's sent to an Amazon SNS topic. You can create an Amazon SNS topic when you create a CloudWatch alarm. For more information about Amazon SNS, see What is Amazon SNS? in the Amazon Simple Notification Service Developer Guide. To create a CloudWatch alarm in the Storage Gateway console 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home/. 2. In the navigation pane, choose Gateways, then choose the gateway for which you want to create an alarm. 3. On the gateway details page, choose the Monitoring tab. 4. Under Alarms, choose Create alarm to open the CloudWatch console. 5. Use the CloudWatch console to create the type of alarm that you want. You can create the following types of alarms: • Static threshold alarm: An alarm based on a set threshold for a chosen metric. The alarm enters the ALARM state when the metric breaches the threshold for a specified number of evaluation periods. To create a static threshold alarm,
|
storagegateway-tgw-ug-062
|
storagegateway-tgw-ug.pdf
| 62 |
the navigation pane, choose Gateways, then choose the gateway for which you want to create an alarm. 3. On the gateway details page, choose the Monitoring tab. 4. Under Alarms, choose Create alarm to open the CloudWatch console. 5. Use the CloudWatch console to create the type of alarm that you want. You can create the following types of alarms: • Static threshold alarm: An alarm based on a set threshold for a chosen metric. The alarm enters the ALARM state when the metric breaches the threshold for a specified number of evaluation periods. To create a static threshold alarm, see Creating a CloudWatch alarm based on a static threshold in the Amazon CloudWatch User Guide. • Anomaly detection alarm: Anomaly detection mines past metric data and creates a model of expected values. You set a value for the anomaly detection threshold, and CloudWatch uses this threshold with the model to determine the "normal" range of values for the metric. A higher value for the threshold produces a thicker band of "normal" values. You can choose to activate the alarm only when the metric value is above the band of expected values, only when it's below the band, or when it's above or below the band. Creating a custom CloudWatch alarm API Version 2013-06-30 154 AWS Storage Gateway Tape Gateway User Guide To create an anomaly detection alarm, see Creating a CloudWatch alarm based on anomaly detection in the Amazon CloudWatch User Guide. • Metric math expression alarm: An alarm based one or more metrics used in a math expression. You specify the expression, threshold, and evaluation periods. To create a metric math expression alarm, see Creating a CloudWatch alarm based on a metric math expression in the Amazon CloudWatch User Guide. • Composite alarm: An alarm that determines its alarm state by watching the alarm states of other alarms. A composite alarm can help you reduce alarm noise. To create a composite alarm, see Creating a composite alarm in the Amazon CloudWatch User Guide. 6. After you create the alarm in the CloudWatch console, return to the Storage Gateway console. You can view the alarm by doing one of the following: • In the navigation pane, choose Gateways, then choose the gateway for which you want to view alarms. On the Details tab, under Alarms, choose CloudWatch Alarms. • In the navigation pane, choose Gateways, choose the gateway for which you want to view alarms, then choose the Monitoring tab. The Alarms section lists all of the CloudWatch alarms for a specific gateway. From here, you can select and delete one or more alarms, turn alarm actions on or off, and create new alarms. • In the navigation pane, choose Gateways, then choose the alarm state of the gateway for which you want to view alarms. For information about how to edit or delete an alarm, see Editing or deleting a CloudWatch alarm. Note When you delete a gateway using the Storage Gateway console, all CloudWatch alarms associated with the gateway are also automatically deleted. Creating a custom CloudWatch alarm API Version 2013-06-30 155 AWS Storage Gateway Tape Gateway User Guide Monitoring Your Tape Gateway This topics in this section describe procedures and conceptual information about how to monitor your Tape Gateway. You can monitor the virtual tapes, cache storage, and the upload buffer that are associated with your Tape Gateway. You use the AWS Management Console to view metrics for your Tape Gateway. With metrics, you can track the health of your Tape Gateway and set up alarms to notify you when one or more metrics are outside a defined threshold. You can use Amazon CloudWatch Logs to get information about the health of your Tape Gateway and related resources. You can use the logs to monitor your gateway for errors that it encounters. In addition, you can use Amazon CloudWatch subscription filters to automate processing of the log information in real time. Storage Gateway provides CloudWatch metrics at no additional charge. Storage Gateway metrics are recorded for a period of two weeks. By using these metrics, you can access historical information and get a better perspective of how your Tape Gateway and virtual tapes are performing. For detailed information about CloudWatch, see the Amazon CloudWatch User Guide. Data throughput, data latency, and operations per second are measures that you can use to understand how your storage applications are performing with Tape Gateway. When you use the correct aggregation statistic, these values can be measured by using the Storage Gateway metrics that are provided for you. Topics • Getting Tape Gateway health logs with CloudWatch log groups • Using Amazon CloudWatch Metrics • Understanding virtual tape metrics • Measuring Performance Between Your Tape Gateway and AWS Getting Tape Gateway health logs with CloudWatch log groups You can use
|
storagegateway-tgw-ug-063
|
storagegateway-tgw-ug.pdf
| 63 |
detailed information about CloudWatch, see the Amazon CloudWatch User Guide. Data throughput, data latency, and operations per second are measures that you can use to understand how your storage applications are performing with Tape Gateway. When you use the correct aggregation statistic, these values can be measured by using the Storage Gateway metrics that are provided for you. Topics • Getting Tape Gateway health logs with CloudWatch log groups • Using Amazon CloudWatch Metrics • Understanding virtual tape metrics • Measuring Performance Between Your Tape Gateway and AWS Getting Tape Gateway health logs with CloudWatch log groups You can use Amazon CloudWatch Logs to get information about the health of your Tape Gateway and related resources. You can use the logs to monitor your gateway for errors that it encounters. In addition, you can use Amazon CloudWatch subscription filters to automate processing of the log information in real time. For more information, see Real-time Processing of Log Data with Subscriptions in the Amazon CloudWatch User Guide. Monitoring Your Tape Gateway API Version 2013-06-30 156 AWS Storage Gateway Tape Gateway User Guide For example, suppose that your gateway is deployed in a cluster activated with VMware HA and you need to know about any errors. You can configure a CloudWatch log group to monitor your gateway and get notified when your gateway encounters an error. You can either configure the group when you are activating the gateway or after your gateway is activated and up and running. For information about how to configure a CloudWatch log group when activating a gateway, see Configure your Tape Gateway. For general information about CloudWatch log groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide. For information about how to troubleshoot and fix these types of errors, see Troubleshooting virtual tape issues. The following procedure shows you how to configure a CloudWatch log group after your gateway is activated. To configure a CloudWatch Log Group to work with your File Gateway 1. Sign in to the AWS Management Console and open the Storage Gateway console at https:// console.aws.amazon.com/storagegateway/home. 2. 3. In the navigation pane, choose Gateways, and then choose the gateway that you want to configure the CloudWatch Log Group for. For Actions, choose Edit gateway information or on the Details tab, under Health logs and Not Enabled, choose Configure log group to open the Edit CustomerGatewayName dialog box. 4. For Gateway health log group, choose one of the following: • Disable logging if you don't want to monitor your gateway using CloudWatch log groups. • Create a new log group to create a new CloudWatch log group. • Use an existing log group to use a CloudWatch log group that already exists. Choose a log group from the Existing log group list. 5. Choose Save changes. 6. To see the health logs for your gateway, do the following: 1. In the navigation pane, choose Gateways, and then choose the gateway that you configured the CloudWatch Log Group for. 2. Choose the Details tab, and under Health logs, choose CloudWatch Logs. The Log group details page opens in the CloudWatch console. Getting Tape Gateway Health Logs API Version 2013-06-30 157 AWS Storage Gateway Tape Gateway User Guide Following is an example of a Tape Gateway event message that is sent to CloudWatch. This example shows a TapeStatusTransition message. { "severity": "INFO", "source": "FZTT16FCF5", "type": "TapeStatusTransition", "gateway": "sgw-C51DFEAC", "timestamp": "1581553463831", "newStatus": "RETRIEVED" } Using Amazon CloudWatch Metrics You can get monitoring data for your Tape Gateway by using either the AWS Management Console or the CloudWatch API. The console displays a series of graphs based on the raw data from the CloudWatch API. The CloudWatch API can also be used through one of the Amazon AWS Software Development Kits (SDKs) or the Amazon CloudWatch API tools. Depending on your needs, you might prefer to use either the graphs displayed in the console or retrieved from the API. Regardless of which method you choose to use to work with metrics, you must specify the following information: • The metric dimension to work with. A dimension is a name-value pair that helps you to uniquely identify a metric. The dimensions for Storage Gateway are GatewayId and GatewayName. In the CloudWatch console, you can use the Gateway Metrics view to easily select gateway-specific and tape-specific dimensions. For more information about dimensions, see Dimensions in the Amazon CloudWatch User Guide. • The metric name, such as ReadBytes. The following table summarizes the types of Storage Gateway metric data that are available to you. Using Amazon CloudWatch Metrics API Version 2013-06-30 158 AWS Storage Gateway Amazon CloudWatch Namespace Dimension Description Tape Gateway User Guide AWS/Stora GatewayId , geGateway GatewayName These dimensions filter for metric data that describes aspects of the Tape Gateway. You can identify
|
storagegateway-tgw-ug-064
|
storagegateway-tgw-ug.pdf
| 64 |
Gateway are GatewayId and GatewayName. In the CloudWatch console, you can use the Gateway Metrics view to easily select gateway-specific and tape-specific dimensions. For more information about dimensions, see Dimensions in the Amazon CloudWatch User Guide. • The metric name, such as ReadBytes. The following table summarizes the types of Storage Gateway metric data that are available to you. Using Amazon CloudWatch Metrics API Version 2013-06-30 158 AWS Storage Gateway Amazon CloudWatch Namespace Dimension Description Tape Gateway User Guide AWS/Stora GatewayId , geGateway GatewayName These dimensions filter for metric data that describes aspects of the Tape Gateway. You can identify a Tape Gateway to work with by specifying both the GatewayId and the GatewayName dimensions. Throughput and latency data of a Tape Gateway is based on all the virtual tapes in the Tape Gateway. Data is available automatically in 5-minute periods at no charge. Working with gateway and tape metrics is similar to working with other service metrics. You can find a discussion of some of the most common metrics tasks in the CloudWatch documentation listed following: • Viewing Available Metrics • Getting Statistics for a Metric • Creating CloudWatch Alarms Understanding virtual tape metrics You can find information following about the Storage Gateway metrics that cover virtual tapes. Each tape has a set of metrics associated with it. Some tape-specific metrics might have the same name as certain gateway-specific metrics. These metrics represent the same kinds of measurements but are scoped to a tape instead of a gateway. Before starting work, specify whether you want to work with a gateway metric or a tape metric. When working with tape metrics, specify the tape ID for the tape that you want to view metrics for. For more information, see Using Amazon CloudWatch Metrics. Understanding virtual tape metrics API Version 2013-06-30 159 AWS Storage Gateway Note Tape Gateway User Guide Some metrics return data points only when new data has been generated during the most recent monitoring period. The following table describes the Storage Gateway metrics that you can use to get information about your tapes. Metric Description CachePercentDirty CloudTraffic IoWaitPercent The tape's contribution to the overall percentage of the gateway's cache that isn't persisted to AWS. The sample is taken at the end of the reporting period. Use the CachePercentDirty metric of the gateway to view the overall percentage of the gateway's cache that isn't persisted to AWS. For more information, see Understan ding gateway metrics. Units: Percent The amount of bytes uploaded and downloaded from the cloud to the tape. Units: bytes The percentage of allocated IoWait units that are currently used by the tape. Units: Percent HealthNotification The number of health notifications sent by the tape. Units: count Understanding virtual tape metrics API Version 2013-06-30 160 AWS Storage Gateway Metric MemUsedBytes MemTotalBytes ReadBytes UserCpuPercent WriteBytes Tape Gateway User Guide Description The percentage of allocated memory that is currently used by the tape. Units: Bytes The percentage of total memory that is currently used by the tape. Units: Bytes The total number of bytes read from your on- premises applications in the reporting period for a file share. Use this metric with the Sum statistic to measure throughput and with the Samples statistic to measure IOPS. Units: Bytes The percentage of allocated CPU compute units for the user that are currently used by the tape. Units: Percent The total number of bytes written to your on- premises applications in the reporting period. Use this metric with the Sum statistic to measure throughput and with the Samples statistic to measure IOPS. Units: Bytes Understanding virtual tape metrics API Version 2013-06-30 161 AWS Storage Gateway Tape Gateway User Guide Measuring Performance Between Your Tape Gateway and AWS Data throughput, data latency, and operations per second are measures that you can use to understand how your application storage that is using your Tape Gateway is performing. When you use the correct aggregation statistic, these values can be measured by using the Storage Gateway metrics that are provided for you. A statistic is an aggregation of a metric over a specified period of time. When you view the values of a metric in CloudWatch, use the Average statistic for data latency (milliseconds), and use the Samples statistic for input/output operations per second (IOPS). For more information, see Statistics in the Amazon CloudWatch User Guide. The following table summarizes the metrics and the corresponding statistic you can use to measure the throughput, latency, and IOPS between your Tape Gateway and AWS. Item of Interest How to Measure Latency Use the ReadTime and WriteTime metrics with the Average CloudWatch statistic. For example, the Average value of the ReadTime metric gives you the latency per operation over the sample period of time. Throughput to AWS Use the CloudBytesDownloaded and CloudBytesUploaded metrics with the Sum CloudWatch statistic.
|
storagegateway-tgw-ug-065
|
storagegateway-tgw-ug.pdf
| 65 |
use the Samples statistic for input/output operations per second (IOPS). For more information, see Statistics in the Amazon CloudWatch User Guide. The following table summarizes the metrics and the corresponding statistic you can use to measure the throughput, latency, and IOPS between your Tape Gateway and AWS. Item of Interest How to Measure Latency Use the ReadTime and WriteTime metrics with the Average CloudWatch statistic. For example, the Average value of the ReadTime metric gives you the latency per operation over the sample period of time. Throughput to AWS Use the CloudBytesDownloaded and CloudBytesUploaded metrics with the Sum CloudWatch statistic. For example, the Sum value of the CloudBytesDownloaded metric over a sample period of 5 minutes divided by 300 seconds gives you the throughput from AWS to the Tape Gateway as a rate in bytes per second. Latency of data to AWS Use the CloudDownloadLatency . For example, the Average statistic of the CloudDownloadLatency metric gives you the latency per operation. metric with the Average statistic To measure the upload data throughput from a Tape Gateway to AWS 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. Choose the Metrics tab. Measuring Performance Between Your Tape Gateway and AWS API Version 2013-06-30 162 AWS Storage Gateway Tape Gateway User Guide 3. Choose the StorageGateway: Gateway Metrics dimension, and find the Tape Gateway that you want to work with. 4. Choose the CloudBytesUploaded metric. 5. For Time Range, choose a value. 6. Choose the Sum statistic. 7. 8. For Period, choose a value of 5 minutes or greater. In the resulting time-ordered set of data points, divide each data point by the period (in seconds) to get the throughput at that sample period. For example, if the throughput from the Tape Gateway to AWS is 555,544,576 bytes for a given data point, and the period is 300 seconds, then the approximate throughput would be 1.85 megabytes per second. To measure the data latency from a Tape Gateway to AWS 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. Choose the Metrics tab. 3. Choose the StorageGateway: GatewayMetrics dimension, and find the Tape Gateway that you want to work with. 4. Choose the CloudDownloadLatency metric. 5. For Time Range, choose a value. 6. Choose the Average statistic. 7. For Period, choose a value of 5 minutes to match the default reporting time. The resulting time-ordered set of data points contains the latency in milliseconds. To set an upper threshold alarm for a Tape Gateway's throughput to AWS 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. Choose Create Alarm to start the Create Alarm wizard. 3. Choose the StorageGateway: Gateway Metrics dimension, and find the Tape Gateway that you want to work with. 4. Choose the CloudBytesUploaded metric. 5. Define the alarm by defining the alarm state when the CloudBytesUploaded metric is greater than or equal to a specified value for a specified time. For example, you can define Measuring Performance Between Your Tape Gateway and AWS API Version 2013-06-30 163 AWS Storage Gateway Tape Gateway User Guide an alarm state when the CloudBytesUploaded metric is greater than 10 megabytes for 60 minutes. 6. Configure the actions to take for the alarm state. For example, you can have an email notification sent to you. 7. Choose Create Alarm. To set an upper threshold alarm for reading data from AWS 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. Choose Create Alarm to start the Create Alarm wizard. 3. Choose the StorageGateway: Gateway Metrics dimension, and find the Tape Gateway that you want to work with. 4. Choose the CloudDownloadLatency metric. 5. Define the alarm by defining the alarm state when the CloudDownloadLatency metric is greater than or equal to a specified value for a specified time. For example, you can define an alarm state when the CloudDownloadLatency is greater than 60,000 milliseconds for greater than 2 hours. 6. Configure the actions to take for the alarm state. For example, you can have an email notification sent to you. 7. Choose Create Alarm. Measuring Performance Between Your Tape Gateway and AWS API Version 2013-06-30 164 AWS Storage Gateway Tape Gateway User Guide Maintaining Your Gateway Maintaining your Tape Gateway includes tasks such as sizing and configuring local disks for cache storage and upload buffer space, managing updates and setting an update schedule, managing bandwidth usage, and shutting down or deleting you gateway and associated resources if necessary. These tasks are common to all gateway types. If you haven't created a gateway, see Creating your gateway. Topics • Managing local disks for your Storage Gateway - Learn how to assess disk size requirements, add cache capacity, and manage the local disks that you allocate to your Tape Gateway for buffering and storage. • Managing Bandwidth for Your Tape Gateway - Learn how to limit the upload throughput from
|
storagegateway-tgw-ug-066
|
storagegateway-tgw-ug.pdf
| 66 |
disks for cache storage and upload buffer space, managing updates and setting an update schedule, managing bandwidth usage, and shutting down or deleting you gateway and associated resources if necessary. These tasks are common to all gateway types. If you haven't created a gateway, see Creating your gateway. Topics • Managing local disks for your Storage Gateway - Learn how to assess disk size requirements, add cache capacity, and manage the local disks that you allocate to your Tape Gateway for buffering and storage. • Managing Bandwidth for Your Tape Gateway - Learn how to limit the upload throughput from your gateway to AWS to control the amount of network bandwidth the gateway uses. • Managing gateway updates - Learn how to turn maintenance updates on or off, and modify the maintenance window schedule for your Tape Gateway. • Shutting Down Your Gateway VM - Learn about what to do if you need to shutdown or reboot your gateway virtual machine for maintenance, such as when applying a patch to your hypervisor. • Deleting your gateway and removing associated resources - Learn how to delete your gateway using the AWS Storage Gateway console and clean up associated resources to avoid being charged for their continued use. Managing local disks for your Storage Gateway The gateway virtual machine (VM) uses the local disks that you allocate on-premises for buffering and storage. Gateways created on Amazon EC2 instances use Amazon EBS volumes as local disks. Topics • Deciding the amount of local disk storage • Configuring additional upload buffer or cache storage Managing local disks API Version 2013-06-30 165 AWS Storage Gateway Tape Gateway User Guide Deciding the amount of local disk storage The number and size of disks that you want to allocate for your gateway is up to you. Depending on the storage solution you deploy, the gateway requires the following additional storage: • Tape Gateways require at least two disks. One to use as a cache, and one to use as an upload buffer. The following table recommends sizes for local disk storage for your deployed gateway. You can add more local storage later after you set up the gateway, and as your workload demands increase. Local storage Upload buffer Cache storage Description The upload buffer provides a staging area for the data before the gateway uploads the data to Amazon S3. Your gateway uploads this buffer data over an encrypted Secure Sockets Layer (SSL) connection to AWS. The cache storage acts as the on-premises durable store for data that is pending upload to Amazon S3 from the upload buffer. When your application performs I/O on a volume or tape, the gateway saves the data to the cache storage for low-laten cy access. When your application requests data from a volume or tape, the gateway first checks the cache storage for the data before downloading the data from AWS. Deciding the amount of local disk storage API Version 2013-06-30 166 AWS Storage Gateway Note Tape Gateway User Guide When you provision disks, we strongly recommend that you do not provision local disks for the upload buffer and cache storage if they use the same physical resource (the same disk). Underlying physical storage resources are represented as a data store in VMware. When you deploy the gateway VM, you choose a data store on which to store the VM files. When you provision a local disk (for example, to use as cache storage or upload buffer), you have the option to store the virtual disk in the same data store as the VM or a different data store. If you have more than one data store, we strongly recommend that you choose one data store for the cache storage and another for the upload buffer. A data store that is backed by only one underlying physical disk can lead to poor performance in some situations when it is used to back both the cache storage and upload buffer. This is also true if the backup is a less-performant RAID configuration such as RAID1. After the initial configuration and deployment of your gateway, you can adjust the local storage by adding or removing disks for an upload buffer. You can also add disks for cache storage. Determining the size of upload buffer to allocate You can determine the size of your upload buffer to allocate by using an upload buffer formula. We strongly recommend that you allocate at least 150 GiB of upload buffer. If the formula returns a value less than 150 GiB, use 150 GiB as the amount you allocate to the upload buffer. You can configure up to 2 TiB of upload buffer capacity for each gateway. Note For Tape Gateways, when the upload buffer reaches its capacity, your applications can continue to read from and write data
|
storagegateway-tgw-ug-067
|
storagegateway-tgw-ug.pdf
| 67 |
add disks for cache storage. Determining the size of upload buffer to allocate You can determine the size of your upload buffer to allocate by using an upload buffer formula. We strongly recommend that you allocate at least 150 GiB of upload buffer. If the formula returns a value less than 150 GiB, use 150 GiB as the amount you allocate to the upload buffer. You can configure up to 2 TiB of upload buffer capacity for each gateway. Note For Tape Gateways, when the upload buffer reaches its capacity, your applications can continue to read from and write data to your storage volumes. However, the Tape Gateway does not write any of your volume data to its upload buffer and does not upload any of this data to AWS until Storage Gateway synchronizes the data stored locally with the copy of the data stored in AWS. This synchronization occurs when the volumes are in BOOTSTRAPPING status. To estimate the amount of upload buffer to allocate, you can determine the expected incoming and outgoing data rates and plug them into the following formula. Deciding the amount of local disk storage API Version 2013-06-30 167 AWS Storage Gateway Rate of incoming data Tape Gateway User Guide This rate refers to the application throughput, the rate at which your on-premises applications write data to your gateway over some period of time. Rate of outgoing data This rate refers to the network throughput, the rate at which your gateway is able to upload data to AWS. This rate depends on your network speed, utilization, and whether you've activated bandwidth throttling. This rate should be adjusted for compression. When uploading data to AWS, the gateway applies data compression where possible. For example, if your application data is text-only, you might get an effective compression ratio of about 2:1. However, if you are writing videos, the gateway might not be able to achieve any data compression and might require more upload buffer for the gateway. We strongly recommend that you allocate at least 150 GiB of upload buffer space if either of the following is true: • Your incoming rate is higher than the outgoing rate. • The formula returns a value less than 150 GiB. For example, assume that your business applications write text data to your gateway at a rate of 40 MB per second for 12 hours per day and your network throughput is 12 MB per second. Assuming a compression factor of 2:1 for the text data, you would allocate approximately 690 GiB of space for the upload buffer. Example ((40 MB/sec) - (12 MB/sec * 2)) * (12 hours * 3600 seconds/hour) = 691200 megabytes You can initially use this approximation to determine the disk size that you want to allocate to the gateway as upload buffer space. Add more upload buffer space as needed using the Storage Gateway console. Also, you can use the Amazon CloudWatch operational metrics to monitor upload Deciding the amount of local disk storage API Version 2013-06-30 168 AWS Storage Gateway Tape Gateway User Guide buffer usage and determine additional storage requirements. For information on metrics and setting the alarms, see Monitoring the upload buffer. Determining the size of cache storage to allocate Your gateway uses its cache storage to provide low-latency access to your recently accessed data. The cache storage acts as the on-premises durable store for data that is pending upload to Amazon S3 from the upload buffer. Generally speaking, you size the cache storage at 1.1 times the upload buffer size. For more information about how to estimate your cache storage size, see Determining the size of upload buffer to allocate. You can initially use this approximation to provision disks for the cache storage. You can then use Amazon CloudWatch operational metrics to monitor the cache storage usage and provision more storage as needed using the console. For information on using the metrics and setting up alarms, see Monitoring cache storage. Configuring additional upload buffer or cache storage As your application needs change, you can increase the gateway's upload buffer or cache storage capacity. You can add storage capacity to your gateway without interrupting functionality or causing downtime. When you add more storage, you do so with the gateway VM turned on. Important When adding cache or upload buffer to an existing gateway, you must create new disks on the gateway host hypervisor or Amazon EC2 instance. Do not remove or change the size of existing disks that have already been allocated as cache or upload buffer. To configure additional upload buffer or cache storage for your gateway 1. Provision one or more new disks on your gateway host hypervisor or Amazon EC2 instance. For information about how to provision a disk on a hypervisor, see your hypervisor's documentation. For information about
|
storagegateway-tgw-ug-068
|
storagegateway-tgw-ug.pdf
| 68 |
storage, you do so with the gateway VM turned on. Important When adding cache or upload buffer to an existing gateway, you must create new disks on the gateway host hypervisor or Amazon EC2 instance. Do not remove or change the size of existing disks that have already been allocated as cache or upload buffer. To configure additional upload buffer or cache storage for your gateway 1. Provision one or more new disks on your gateway host hypervisor or Amazon EC2 instance. For information about how to provision a disk on a hypervisor, see your hypervisor's documentation. For information about provisioning Amazon EBS volumes for an Amazon EC2 instance, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide for Linux Instances. In the following steps, you will configure this disk as upload buffer or cache storage. 2. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 3. In the navigation pane, choose Gateways. Add upload buffer or cache storage API Version 2013-06-30 169 AWS Storage Gateway Tape Gateway User Guide 4. 5. 6. Search for your gateway and select it from the list. From the Actions menu, choose Configure storage. In the Configure storage section, identify the disks you provisioned. If you don't see your disks, choose the refresh icon to refresh the list. For each disk, choose either UPLOAD BUFFER or CACHE STORAGE from the Allocated to drop-down menu. 7. Choose Save changes to save your configuration settings. Managing Bandwidth for Your Tape Gateway You can limit (or throttle) the upload throughput from the gateway to AWS or the download throughput from AWS to your gateway. Using bandwidth throttling helps you to control the amount of network bandwidth used by your gateway. By default, an activated gateway has no rate limits on upload or download. You can specify the rate limit by using the AWS Management Console, or programmatically by using either the Storage Gateway API (see UpdateBandwidthRateLimit) or an AWS Software Development Kit (SDK). By throttling bandwidth programmatically, you can change limits automatically throughout the day—for example, by scheduling tasks to change the bandwidth. You can also define schedule-based bandwidth throttling for your gateway. You schedule bandwidth throttling by defining one or more bandwidth-rate-limit intervals. For more information, see Schedule-Based Bandwidth Throttling Using the Storage Gateway Console. Configuring a single setting for bandwidth throttling is the functional equivalent of defining a schedule with a single bandwidth-rate-limit interval set for Everyday, with a Start time of 00:00 and an End time of 23:59. Note The information in this section is specific to Tape and Volume Gateways. To manage bandwidth for an Amazon S3 File Gateway, see Managing Bandwidth for Your Amazon S3 File Gateway. Bandwidth-rate limits are currently not supported for Amazon FSx File Gateway. Topics • Changing Bandwidth Throttling Using the Storage Gateway Console Managing Bandwidth API Version 2013-06-30 170 AWS Storage Gateway Tape Gateway User Guide • Schedule-Based Bandwidth Throttling Using the Storage Gateway Console • Updating Gateway Bandwidth-Rate Limits Using the AWS SDK for Java • Updating Gateway Bandwidth-Rate Limits Using the AWS SDK for .NET • Updating Gateway Bandwidth-Rate Limits Using the AWS Tools for Windows PowerShell Changing Bandwidth Throttling Using the Storage Gateway Console The following procedure shows how to change a gateway's bandwidth throttling from the Storage Gateway console. To change a gateway's bandwidth throttling using the console 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. 3. 4. In the left navigation pane, choose Gateways, and then choose the gateway that you want to manage. For Actions, choose Edit bandwidth limit. In the Edit rate limits dialog box, enter new limit values, and then choose Save. Your changes appear in the Details tab for your gateway. Schedule-Based Bandwidth Throttling Using the Storage Gateway Console The following procedure shows how to schedule changes to a gateway's bandwidth throttling using the Storage Gateway console. To add or modify a schedule for gateway bandwidth throttling 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. In the left navigation pane, choose Gateways, and then choose the gateway that you want to manage. 3. For Actions, choose Edit bandwidth rate limit schedule. The gateway's bandwidth-rate-limit schedule is displayed in the Edit bandwidth rate limit schedule dialog box. By default, a new gateway bandwidth-rate-limit schedule is empty. Changing Bandwidth Throttling Using the Storage Gateway Console API Version 2013-06-30 171 AWS Storage Gateway Tape Gateway User Guide 4. In the Edit bandwidth rate limit schedule dialog box, choose Add new item to add a new bandwidth-rate-limit interval. Enter the following information for each bandwidth-rate-limit interval: • Days of week – You can create the bandwidth-rate-limit interval for weekdays (Monday through Friday), for weekends (Saturday and Sunday), for every day of the week, or for one or more specific days of the week. • Start time
|
storagegateway-tgw-ug-069
|
storagegateway-tgw-ug.pdf
| 69 |
limit schedule dialog box. By default, a new gateway bandwidth-rate-limit schedule is empty. Changing Bandwidth Throttling Using the Storage Gateway Console API Version 2013-06-30 171 AWS Storage Gateway Tape Gateway User Guide 4. In the Edit bandwidth rate limit schedule dialog box, choose Add new item to add a new bandwidth-rate-limit interval. Enter the following information for each bandwidth-rate-limit interval: • Days of week – You can create the bandwidth-rate-limit interval for weekdays (Monday through Friday), for weekends (Saturday and Sunday), for every day of the week, or for one or more specific days of the week. • Start time – Enter the start time for the bandwidth interval in the gateway's local timezone, using the HH:MM format. Note Your bandwidth-rate-limit interval begins at the start of the minute that you specify here. • End time – Enter the end time for the bandwidth-rate-limit interval in the gateway's local time zone, using the HH:MM format. Important The bandwidth-rate-limit interval ends at the end of the minute specified here. To schedule an interval that ends at the end of an hour, enter 59. To schedule consecutive continuous intervals, transitioning at the start of the hour, with no interruption between the intervals, enter 59 for the end minute of the first interval. Enter 00 for the start minute of the succeeding interval. • Download rate – Enter the download rate limit, in kilobits per second (Kbps), or select No limit to deactivate bandwidth throttling for downloading. The minimum value for the download rate is 100 Kbps. • Upload rate – Enter the upload rate limit, in Kbps, or select No limit to deactivate bandwidth throttling for uploading. The minimum value for the upload rate is 50 Kbps. To modify your bandwidth-rate-limit intervals, you can enter revised values for the interval parameters. To remove your bandwidth-rate-limit intervals, you can choose Remove to the right of the interval to be deleted. Scheduling Bandwidth Throttling API Version 2013-06-30 172 AWS Storage Gateway Tape Gateway User Guide When your changes are complete, choose Save. 5. Continue adding bandwidth-rate-limit intervals by choosing Add new item and entering the day, the start and end times, and the download and upload rate limits. Important Bandwidth-rate-limit intervals cannot overlap. The start time of an interval must occur after the end time of a preceding interval, and before the start time of a following interval. 6. After entering all bandwidth-rate-limit intervals, choose Save changes to save your bandwidth-rate-limit schedule. When the bandwidth-rate-limit schedule is successfully updated, you can see the current download and upload rate limits in the Details panel for the gateway. Updating Gateway Bandwidth-Rate Limits Using the AWS SDK for Java By updating bandwidth-rate limits programmatically, you can adjust your limits automatically over a period of time—for example, by using scheduled tasks. The following example demonstrates how to update a gateway's bandwidth-rate limits using the AWS SDK for Java. To use the example code, you should be familiar with running a Java console application. For more information, see Getting Started in the AWS SDK for Java Developer Guide. Example : Updating Gateway Bandwidth-Rate Limits Using the AWS SDK for Java The following Java code example updates a gateway's bandwidth-rate limits. To use this example code, you must provide the service endpoint, your gateway Amazon Resource Name (ARN), and the upload and download limits. For a list of AWS service endpoints that you can use with Storage Gateway, see AWS Storage Gateway Endpoints and Quotas in the AWS General Reference. import java.io.IOException; import com.amazonaws.AmazonClientException; import com.amazonaws.auth.PropertiesCredentials; import com.amazonaws.services.storagegateway.AWSStorageGatewayClient; import com.amazonaws.services.storagegateway.model.UpdateBandwidthRateLimitRequest; import com.amazonaws.services.storagegateway.model.UpdateBandwidthRateLimitResult; Using the AWS SDK for Java API Version 2013-06-30 173 AWS Storage Gateway Tape Gateway User Guide public class UpdateBandwidthExample { public static AWSStorageGatewayClient sgClient; // The gatewayARN public static String gatewayARN = "*** provide gateway ARN ***"; // The endpoint static String serviceURL = "https://storagegateway.us-east-1.amazonaws.com"; // Rates static long uploadRate = 51200; // Bits per second, minimum 51200 static long downloadRate = 102400; // Bits per second, minimum 102400 public static void main(String[] args) throws IOException { // Create a Storage Gateway client sgClient = new AWSStorageGatewayClient(new PropertiesCredentials( UpdateBandwidthExample.class.getResourceAsStream("AwsCredentials.properties"))); sgClient.setEndpoint(serviceURL); UpdateBandwidth(gatewayARN, uploadRate, downloadRate); } private static void UpdateBandwidth(String gatewayARN2, long uploadRate2, long downloadRate2) { try { UpdateBandwidthRateLimitRequest updateBandwidthRateLimitRequest = new UpdateBandwidthRateLimitRequest() .withGatewayARN(gatewayARN) .withAverageDownloadRateLimitInBitsPerSec(downloadRate) .withAverageUploadRateLimitInBitsPerSec(uploadRate); UpdateBandwidthRateLimitResult updateBandwidthRateLimitResult = sgClient.updateBandwidthRateLimit(updateBandwidthRateLimitRequest); String returnGatewayARN = updateBandwidthRateLimitResult.getGatewayARN(); System.out.println("Updated the bandwidth rate limits of " + returnGatewayARN); System.out.println("Upload bandwidth limit = " + uploadRate + " bits per second"); Using the AWS SDK for Java API Version 2013-06-30 174 AWS Storage Gateway Tape Gateway User Guide System.out.println("Download bandwidth limit = " + downloadRate + " bits per second"); } catch (AmazonClientException ex) { System.err.println("Error updating gateway bandwith.\n" + ex.toString()); } } } Updating Gateway Bandwidth-Rate Limits Using the AWS SDK for .NET By updating bandwidth-rate limits programmatically, you can adjust your limits automatically
|
storagegateway-tgw-ug-070
|
storagegateway-tgw-ug.pdf
| 70 |
updateBandwidthRateLimitRequest = new UpdateBandwidthRateLimitRequest() .withGatewayARN(gatewayARN) .withAverageDownloadRateLimitInBitsPerSec(downloadRate) .withAverageUploadRateLimitInBitsPerSec(uploadRate); UpdateBandwidthRateLimitResult updateBandwidthRateLimitResult = sgClient.updateBandwidthRateLimit(updateBandwidthRateLimitRequest); String returnGatewayARN = updateBandwidthRateLimitResult.getGatewayARN(); System.out.println("Updated the bandwidth rate limits of " + returnGatewayARN); System.out.println("Upload bandwidth limit = " + uploadRate + " bits per second"); Using the AWS SDK for Java API Version 2013-06-30 174 AWS Storage Gateway Tape Gateway User Guide System.out.println("Download bandwidth limit = " + downloadRate + " bits per second"); } catch (AmazonClientException ex) { System.err.println("Error updating gateway bandwith.\n" + ex.toString()); } } } Updating Gateway Bandwidth-Rate Limits Using the AWS SDK for .NET By updating bandwidth-rate limits programmatically, you can adjust your limits automatically over a period of time—for example, by using scheduled tasks. The following example demonstrates how to update a gateway's bandwidth-rate limits by using the AWS SDK for .NET. To use the example code, you should be familiar with running a .NET console application. For more information, see Getting Started in the AWS SDK for .NET Developer Guide. Example : Updating Gateway Bandwidth-Rate Limits by Using the AWS SDK for .NET The following C# code example updates a gateway's bandwidth-rate limits. To use this example code, you must provide the service endpoint, your gateway Amazon Resource Name (ARN), and the upload and download limits. For a list of AWS service endpoints that you can use with Storage Gateway, see AWS Storage Gateway Endpoints and Quotas in the AWS General Reference. using System; using System.Collections.Generic; using System.Linq; using System.Text; using Amazon.StorageGateway; using Amazon.StorageGateway.Model; namespace AWSStorageGateway { class UpdateBandwidthExample { static AmazonStorageGatewayClient sgClient; static AmazonStorageGatewayConfig sgConfig; // The gatewayARN public static String gatewayARN = "*** provide gateway ARN ***"; Using the AWS SDK for .NET API Version 2013-06-30 175 AWS Storage Gateway // The endpoint Tape Gateway User Guide static String serviceURL = "https://storagegateway.us-east-1.amazonaws.com"; // Rates static long uploadRate = 51200; // Bits per second, minimum 51200 static long downloadRate = 102400; // Bits per second, minimum 102400 public static void Main(string[] args) { // Create a Storage Gateway client sgConfig = new AmazonStorageGatewayConfig(); sgConfig.ServiceURL = serviceURL; sgClient = new AmazonStorageGatewayClient(sgConfig); UpdateBandwidth(gatewayARN, uploadRate, downloadRate); Console.WriteLine("\nTo continue, press Enter."); Console.Read(); } public static void UpdateBandwidth(string gatewayARN, long uploadRate, long downloadRate) { try { UpdateBandwidthRateLimitRequest updateBandwidthRateLimitRequest = new UpdateBandwidthRateLimitRequest() .WithGatewayARN(gatewayARN) .WithAverageDownloadRateLimitInBitsPerSec(downloadRate) .WithAverageUploadRateLimitInBitsPerSec(uploadRate); UpdateBandwidthRateLimitResponse updateBandwidthRateLimitResponse = sgClient.UpdateBandwidthRateLimit(updateBandwidthRateLimitRequest); String returnGatewayARN = updateBandwidthRateLimitResponse.UpdateBandwidthRateLimitResult.GatewayARN; Console.WriteLine("Updated the bandwidth rate limits of " + returnGatewayARN); Console.WriteLine("Upload bandwidth limit = " + uploadRate + " bits per second"); Console.WriteLine("Download bandwidth limit = " + downloadRate + " bits per second"); } catch (AmazonStorageGatewayException ex) { Using the AWS SDK for .NET API Version 2013-06-30 176 AWS Storage Gateway Tape Gateway User Guide Console.WriteLine("Error updating gateway bandwith.\n" + ex.ToString()); } } } } Updating Gateway Bandwidth-Rate Limits Using the AWS Tools for Windows PowerShell By updating bandwidth-rate limits programmatically, you can adjust limits automatically over a period of time—for example, by using scheduled tasks. The following example demonstrates how to update a gateway's bandwidth-rate limits using the AWS Tools for Windows PowerShell. To use the example code, you should be familiar with running a PowerShell script. For more information, see Getting Started in the AWS Tools for Windows PowerShell User Guide. Example : Updating Gateway Bandwidth-Rate Limits by Using the AWS Tools for Windows PowerShell The following PowerShell script example updates a gateway's bandwidth-rate limits. To use this example script, you must provide your gateway Amazon Resource Name (ARN), and the upload and download limits. <# .DESCRIPTION Update Gateway bandwidth limits. .NOTES PREREQUISITES: 1) AWS Tools for PowerShell from https://aws.amazon.com/powershell/ 2) Credentials and region stored in session using Initialize-AWSDefault. For more info, see https://docs.aws.amazon.com/powershell/latest/userguide/ specifying-your-aws-credentials.html .EXAMPLE powershell.exe .\SG_UpdateBandwidth.ps1 #> $UploadBandwidthRate = 51200 $DownloadBandwidthRate = 102400 Using the AWS Tools for Windows PowerShell API Version 2013-06-30 177 AWS Storage Gateway Tape Gateway User Guide $gatewayARN = "*** provide gateway ARN ***" #Update Bandwidth Rate Limits Update-SGBandwidthRateLimit -GatewayARN $gatewayARN ` -AverageUploadRateLimitInBitsPerSec $UploadBandwidthRate ` -AverageDownloadRateLimitInBitsPerSec $DownloadBandwidthRate $limits = Get-SGBandwidthRateLimit -GatewayARN $gatewayARN Write-Output("`nGateway: " + $gatewayARN); Write-Output("`nNew Upload Rate: " + $limits.AverageUploadRateLimitInBitsPerSec) Write-Output("`nNew Download Rate: " + $limits.AverageDownloadRateLimitInBitsPerSec) Managing gateway updates Storage Gateway consists of a managed cloud services component and a gateway appliance component that you deploy either on-premises, or on an Amazon EC2 instance in the AWS cloud. Both components receive regular updates. The topics in this section describe the cadence of these updates, how they are applied, and how to configure update-related settings on the gateways in your deployment. Important You should treat the Storage Gateway appliance as a managed virtual machine, and should not attempt to access or modify its installation in any way. Attempting to install or update any software packages using methods other than the normal AWS gateway update mechanism (for example, SSM or hypervisor tools) may cause the gateway to malfunction. Update frequency and expected behavior AWS updates the cloud services component as needed without causing disruption to deployed gateways.
|
storagegateway-tgw-ug-071
|
storagegateway-tgw-ug.pdf
| 71 |
in this section describe the cadence of these updates, how they are applied, and how to configure update-related settings on the gateways in your deployment. Important You should treat the Storage Gateway appliance as a managed virtual machine, and should not attempt to access or modify its installation in any way. Attempting to install or update any software packages using methods other than the normal AWS gateway update mechanism (for example, SSM or hypervisor tools) may cause the gateway to malfunction. Update frequency and expected behavior AWS updates the cloud services component as needed without causing disruption to deployed gateways. Your deployed gateway appliances receive monthly maintenance updates. Monthly maintenance updates can include operating system and software upgrades, fixes to address stability, performance, and security, and access to new features. All updates are cumulative, and upgrade gateways to the current version when applied. For information about the specific changes included in each update, see Release Notes for Tape Gateway Appliance Software. Managing gateway updates API Version 2013-06-30 178 AWS Storage Gateway Tape Gateway User Guide Monthly maintenance updates may cause a brief disruption of service. The gateway's VM host doesn't need to reboot during updates, but the gateway will be unavailable for a short period while the gateway appliance updates and restarts. You can minimize the chance of any disruption to your applications due to the gateway restart by increasing the timeouts of your iSCSI initiator. For more information about increasing iSCSI initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings. When you deploy and activate your gateway, a default weekly maintenance window schedule is set. You can modify the maintenance window schedule at any time. You can also turn off monthly maintenance updates, but we recommend leaving them turned on. Note Urgent updates will sometimes be applied according to the maintenance window schedule, even if regular maintenance updates are turned off. Before any update is applied to your gateway, AWS notifies you with a message on the Storage Gateway console and your AWS Health Dashboard. For more information, see AWS Health Dashboard. To modify the email address where software update notifications are sent, see Update the alternate contacts for your AWS account in the AWS Account Management Reference Guide. When updates are available, the gateway Details tab displays a maintenance message. You can also see the date and time that the last successful update was applied on the Details tab. Turn maintenance updates on or off When maintenance updates are turned on, your gateway automatically applies these updates according to the configured maintenance window schedule. For more information, see . If maintenance updates are turned off, the gateway will not apply these updates automatically, but you can always apply them manually using the Storage Gateway console, API, or CLI. Urgent updates will sometimes be applied during your configured maintenance window, regardless of this setting. Turn maintenance updates on or off API Version 2013-06-30 179 AWS Storage Gateway Note Tape Gateway User Guide The following procedure describes how to turn gateway updates on or off using the Storage Gateway console. To change this setting programmatically using the API, see UpdateMaintenanceStartTime in the Storage Gateway API Reference. To turn maintenance updates on or off using the Storage Gateway console: 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. On the navigation pane, choose Gateways, and then choose the gateway for which you want to configure maintenance updates. 3. Choose Actions, and then choose Edit maintenance settings. 4. For Maintenance updates, select On or Off. 5. Choose Save changes when finished. You can verify the updated setting on the Details tab for the selected gateway in the Storage Gateway console. Modify the gateway maintenance window schedule If maintenance updates are turned on, your gateway automatically applies these updates according the maintenance window schedule. Urgent updates will sometimes be applied during your configured maintenance window, regardless of the maintenance updates setting. Note The following procedure describes how to modify the maintenance window schedule using the Storage Gateway console. To change this setting programmatically using the API, see UpdateMaintenanceStartTime in the Storage Gateway API Reference. To modify the maintenance window schedule using the Storage Gateway console: 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. Modify the gateway maintenance window schedule API Version 2013-06-30 180 AWS Storage Gateway Tape Gateway User Guide 2. On the navigation pane, choose Gateways, and then choose the gateway for which you want to configure maintenance updates. 3. Choose Actions, and then choose Edit maintenance settings. 4. Under Maintenance window start time, do the following: a. b. For Schedule, choose Weekly or Monthly to set the maintenance window cadence. If you choose Weekly, modify the values for Day of the week and Time to set the specific point during
|
storagegateway-tgw-ug-072
|
storagegateway-tgw-ug.pdf
| 72 |
Gateway console: 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. Modify the gateway maintenance window schedule API Version 2013-06-30 180 AWS Storage Gateway Tape Gateway User Guide 2. On the navigation pane, choose Gateways, and then choose the gateway for which you want to configure maintenance updates. 3. Choose Actions, and then choose Edit maintenance settings. 4. Under Maintenance window start time, do the following: a. b. For Schedule, choose Weekly or Monthly to set the maintenance window cadence. If you choose Weekly, modify the values for Day of the week and Time to set the specific point during each week when the maintenance window will begin. If you choose Monthly, modify the values for Day of the month and Time to set the specific point during each month when the maintenance window will begin. Note The maximum value that can be set for day of the month is 28. It is not possible to set the maintenance schedule to start on days 29 through 31. If you receive an error while configuring this setting, it might mean that your gateway software is out of date. Considering updating your gateway manually first, and then attempt to configure the maintenance window schedule again. 5. Choose Save changes when finished. You can verify the updated settings on the Details tab for the selected gateway in the Storage Gateway console. Apply an update manually If a software update is available for your gateway, you can apply it manually by following the procedure below. This manual update process ignores the maintenance window schedule and applies the update immediately, even if maintenance updates are turned off. Note The following procedure describes how to manually apply an update using the Storage Gateway console. To perform this action programmatically using the API, see UpdateGatewaySoftwareNow in the Storage Gateway API Reference. Apply an update manually API Version 2013-06-30 181 AWS Storage Gateway Tape Gateway User Guide To apply a gateway software update manually using the Storage Gateway console: 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. On the navigation pane, choose Gateways, and then choose the gateway you want to update. If an update is available, the console displays a blue notification banner on the gateway Details tab, which includes an option to apply the update. 3. Choose Apply update now to immediately update the gateway. Note This operation causes a temporary disruption to gateway functionality while the update installs. During this time, the gateway status appears OFFLINE in the Storage Gateway console. After the update finishes installing, the gateway resumes normal operation and its status changes to RUNNING. You can verify that the gateway software was updated to the latest version by checking the Details tab for the selected gateway in the Storage Gateway console. Shutting Down Your Gateway VM You might need to shutdown or reboot your VM for maintenance, such as when applying a patch to your hypervisor. Before you shutdown the VM, you must first stop the gateway. Although this section focuses on starting and stopping your gateway using the Storage Gateway Management Console, you can also and stop your gateway by using your VM local console or Storage Gateway API. When you power on your VM, remember to restart your gateway. Important If you stop and start an Amazon EC2 gateway that uses ephemeral storage, the gateway will be permanently offline. This happens because the physical storage disk is replaced. There is no work-around for this issue. The only resolution is to delete the gateway and activate a new one on a new EC2 instance. Shutting Down Your Gateway VM API Version 2013-06-30 182 AWS Storage Gateway Note Tape Gateway User Guide If you stop your gateway while your backup software is writing or reading from a tape, the write or read task might not succeed. Before you stop your gateway, you should check your backup software and the backup schedule for any tasks in progress. • Gateway VM local console—see Logging in to the Tape Gateway local console. • Storage Gateway API-—see ShutdownGateway Starting and Stopping a Tape Gateway To stop a Tape Gateway 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. 3. In the navigation pane, choose Gateways, and then choose the gateway to stop. The status of the gateway is Running. For Actions, choose Stop gateway and verify the id of the gateway from the dialog box, and then choose Stop gateway. While the gateway is stopping, you might see a message that indicates the status of the gateway. When the gateway shuts down, a message and a Start gateway button appears in the Details tab. When you stop your gateway, the storage resources will not be accessible until you start your storage. If the gateway was uploading data when it was stopped, the upload
|
storagegateway-tgw-ug-073
|
storagegateway-tgw-ug.pdf
| 73 |
choose Gateways, and then choose the gateway to stop. The status of the gateway is Running. For Actions, choose Stop gateway and verify the id of the gateway from the dialog box, and then choose Stop gateway. While the gateway is stopping, you might see a message that indicates the status of the gateway. When the gateway shuts down, a message and a Start gateway button appears in the Details tab. When you stop your gateway, the storage resources will not be accessible until you start your storage. If the gateway was uploading data when it was stopped, the upload will resume when you start the gateway. To start a Tape Gateway 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. In the navigation pane, choose Gateways and then choose the gateway to start. The status of the gateway is Shutdown. 3. Choose Details. and then choose Start gateway. Starting and Stopping a Tape Gateway API Version 2013-06-30 183 AWS Storage Gateway Tape Gateway User Guide Deleting your gateway and removing associated resources If you don't plan to continue using your gateway, consider deleting the gateway and its associated resources. Removing resources avoids incurring charges for resources you don't plan to continue using and helps reduce your monthly bill. When you delete a gateway, it no longer appears on the AWS Storage Gateway Management Console and its iSCSI connection to the initiator is closed. The procedure for deleting a gateway is the same for all gateway types; however, depending on the type of gateway you want to delete and the host it is deployed on, you follow specific instructions to remove associated resources. Note When you delete a Tape Gateway, any tapes that are currently in the AVAILABLE status are also deleted, and any data on those tapes is lost. If you want to retain data from tapes that are being used by a gateway that you want to delete, you must archive the tapes before you delete the gateway. For more information, see Archiving Virtual Tapes. You can delete a gateway using the Storage Gateway console or programmatically. You can find information following about how to delete a gateway using the Storage Gateway console. If you want to programmatically delete your gateway, see AWS Storage Gateway API Reference. Topics • Deleting Your Gateway by Using the Storage Gateway Console • Removing Resources from a Gateway Deployed On-Premises • Removing Resources from a Gateway Deployed on an Amazon EC2 Instance Deleting Your Gateway by Using the Storage Gateway Console The procedure for deleting a gateway is the same for all gateway types. However, depending on the type of gateway you want to delete and the host the gateway is deployed on, you might have to perform additional tasks to remove resources associated with the gateway. Removing these resources helps you avoid paying for resources you don't plan to use. Deleting your gateway and removing resources API Version 2013-06-30 184 AWS Storage Gateway Note Tape Gateway User Guide For gateways deployed on an Amazon EC2 instance, the instance continues to exist until you delete it. For gateways deployed on a virtual machine (VM), after you delete your gateway the gateway VM still exists in your virtualization environment. To remove the VM, use the VMware vSphere client, Microsoft Hyper-V Manager, or Linux Kernel-based Virtual Machine (KVM) client to connect to the host and remove the VM. Note that you can't reuse the deleted gateway's VM to activate a new gateway. To delete a gateway 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. Choose Gateways, then select one or more gateways to delete. 3. For Actions, choose Delete gateway. The confirmation dialog box appears. Warning Before you do this step, make sure that there are no applications currently writing to the gateway's volumes. If you delete the gateway while it is in use, data loss can occur. When a gateway is deleted, there is no way to get it back. 4. Verify that you want to delete the specified gateways, then type the word delete in the confirmation box, and choose Delete. 5. (Optional) If you want to provide feedback about your deleted gateway, complete the feedback dialog box, then choose Submit. Otherwise, choose Skip. Important You no longer pay software charges after you delete a gateway, but resources such as virtual tapes, Amazon Elastic Block Store (Amazon EBS) snapshots, and Amazon EC2 instances persist. You will continue to be billed for these resources. You can choose to remove Amazon EC2 instances and Amazon EBS snapshots by canceling your Amazon Deleting Your Gateway by Using the Storage Gateway Console API Version 2013-06-30 185 AWS Storage Gateway Tape Gateway User Guide EC2 subscription. If you want to keep your Amazon EC2 subscription, you can delete your Amazon EBS snapshots using the
|
storagegateway-tgw-ug-074
|
storagegateway-tgw-ug.pdf
| 74 |
choose Submit. Otherwise, choose Skip. Important You no longer pay software charges after you delete a gateway, but resources such as virtual tapes, Amazon Elastic Block Store (Amazon EBS) snapshots, and Amazon EC2 instances persist. You will continue to be billed for these resources. You can choose to remove Amazon EC2 instances and Amazon EBS snapshots by canceling your Amazon Deleting Your Gateway by Using the Storage Gateway Console API Version 2013-06-30 185 AWS Storage Gateway Tape Gateway User Guide EC2 subscription. If you want to keep your Amazon EC2 subscription, you can delete your Amazon EBS snapshots using the Amazon EC2 console. Removing Resources from a Gateway Deployed On-Premises You can use the instructions following to remove resources from a gateway that is deployed on- premises. Removing Resources from a Tape Gateway Deployed on a VM When you delete a gateway–virtual tape library (VTL), you perform additional cleanup steps before and after you delete the gateway. These additional steps help you remove resources you don't need so you don't continue to pay for them. If the Tape Gateway you want to delete is deployed on a virtual machine (VM), we suggest that you take the following actions to clean up resources. Important Before you delete a Tape Gateway, you must cancel all tape retrieval operations and eject all retrieved tapes. After you have deleted the Tape Gateway, you must remove any resources associated with the Tape Gateway that you don't need to avoid paying for those resources. When you delete a Tape Gateway, you can encounter one of two scenarios. • The Tape Gateway is connected to AWS – If the Tape Gateway is connected to AWS and you delete the gateway, the iSCSI targets associated with the gateway (that is, the virtual tape drives and media changer) will no longer be available. • The Tape Gateway is not connected to AWS – If the Tape Gateway is not connected to AWS, for example if the underlying VM is turned off or your network is down, then you cannot delete the gateway. If you attempt to do so, after your environment is back up and running you might have a Tape Gateway running on-premises with available iSCSI targets. However, no Tape Gateway data will be uploaded to, or downloaded from, AWS. Removing Resources from a Gateway Deployed On-Premises API Version 2013-06-30 186 AWS Storage Gateway Tape Gateway User Guide If the Tape Gateway you want to delete is not functioning, you must first deactivate it before you delete it, as described following: • To delete tapes that have the RETRIEVED status from the library, eject the tape using your backup software. For instructions, see Archiving the Tape. After deactivating the Tape Gateway and deleting tapes, you can delete the Tape Gateway. For instructions on how to delete a gateway, see Deleting Your Gateway by Using the Storage Gateway Console. If you have tapes archived, those tapes remain and you continue to pay for storage until you delete them. For instruction on how to delete tapes from a archive. see Deleting virtual tapes from your Tape Gateway. Important You are charged for a minimum of 90 days storage for virtual tapes in a archive. If you retrieve a virtual tape that has been stored in the archive for less than 90 days, you are still charged for 90 days storage. Removing Resources from a Gateway Deployed on an Amazon EC2 Instance If you want to delete a gateway that you deployed on an Amazon EC2 instance, we recommend that you clean up the AWS resources that were used with the gateway, specifically the Amazon EC2 instance, any Amazon EBS volumes, and also tapes if you deployed a Tape Gateway. Doing so helps avoid unintended usage charges. Removing Resources from Your Tape Gateway Deployed on Amazon EC2 If you deployed a Tape Gateway, we suggest that you take the following actions to delete your gateway and clean up its resources: 1. Delete all virtual tapes that you have retrieved to your Tape Gateway. For more information, see Deleting virtual tapes from your Tape Gateway. 2. Delete all virtual tapes from the tape library. For more information, see Deleting virtual tapes from your Tape Gateway. Removing Resources from a Gateway Deployed on an Amazon EC2 Instance API Version 2013-06-30 187 AWS Storage Gateway Tape Gateway User Guide 3. Delete the Tape Gateway. For more information, see Deleting Your Gateway by Using the Storage Gateway Console. 4. Terminate all Amazon EC2 instances, and delete all Amazon EBS volumes. For more information, see Clean Up Your Instance and Volume in the Amazon EC2 User Guide. 5. Delete all archived virtual tapes. For more information, see Deleting virtual tapes from your Tape Gateway. Important You are charged for a minimum of 90 days storage for
|
storagegateway-tgw-ug-075
|
storagegateway-tgw-ug.pdf
| 75 |
your Tape Gateway. Removing Resources from a Gateway Deployed on an Amazon EC2 Instance API Version 2013-06-30 187 AWS Storage Gateway Tape Gateway User Guide 3. Delete the Tape Gateway. For more information, see Deleting Your Gateway by Using the Storage Gateway Console. 4. Terminate all Amazon EC2 instances, and delete all Amazon EBS volumes. For more information, see Clean Up Your Instance and Volume in the Amazon EC2 User Guide. 5. Delete all archived virtual tapes. For more information, see Deleting virtual tapes from your Tape Gateway. Important You are charged for a minimum of 90 days storage for virtual tapes in the archive. If you retrieve a virtual tape that has been stored in the archive for less than 90 days, you are still charged for 90 days storage. Removing Resources from a Gateway Deployed on an Amazon EC2 Instance API Version 2013-06-30 188 AWS Storage Gateway Tape Gateway User Guide Performing maintenance tasks using the local console This section contains the following topics, which provide information about how to perform maintenance tasks using the gateway appliance local console. The local console runs directly on the virtualization host platform that hosts your gateway appliance. For on-premises gateways, you access the local console through your VMware, Hyper-v, or Linux KVM virtualization host. For Amazon EC2 gateways, you access the console by connecting to the Amazon EC2 instance using SSH. Most of the tasks are common across the different host platforms, but there are also some differences. Topics • Accessing the Gateway Local Console - Learn how to log into the local console for an on- premises gateway hosted on a Linux Kernel-based Virtual Machine (KVM), VMware ESXi, or Microsoft Hyper-V Manager platform. • Performing Tasks on the VM Local Console - Learn how to use the local console to perform basic setup and advanced configuration tasks for an on-premises gateway, such as configuring an HTTP proxy, viewing system resource status, or running terminal commands. • Performing Tasks on the Amazon EC2 Local Console - Learn how to log into the local console to perform basic setup and advanced configuration tasks for an Amazon EC2 gateway, such as configuring an HTTP proxy, viewing system resource status, or running terminal commands. Accessing the Gateway Local Console How you access your VM's local console depends on the type of the Hypervisor you deployed your gateway VM on. In this section, you can find information on how to access the VM local console using Linux Kernel-based Virtual Machine (KVM), VMware ESXi, and Microsoft Hyper-V Manager. Topics • Accessing the Gateway Local Console with Linux KVM • Accessing the Gateway Local Console with VMware ESXi • Access the Gateway Local Console with Microsoft Hyper-V Accessing the Gateway Local Console API Version 2013-06-30 189 AWS Storage Gateway Tape Gateway User Guide Accessing the Gateway Local Console with Linux KVM There are different ways to configure virtual machines running on KVM, depending on the Linux distribution being used. Instructions for accessing KVM configuration options from the command line follow. Instructions might differ depending on your KVM implementation. To access your gateway's local console with KVM 1. Use the following command to list the VMs that are currently available in KVM. # virsh list The command returns a list of VMs with Id, Name, and State information for each. Note the Id of the VM for which you want to launch the gateway local console. 2. Use the following command to access the local console. # virsh console Id Replace Id with the Id of the VM you noted in the previous step. The AWS Appliance gateway local console prompts you to login to change your network configuration and other settings. 3. Enter your username and password to log into the gateway local console. For more information, see Logging in to the Tape Gateway local console. After you log in, the AWS Appliance Activation - Configuration menu appears. You can select from the menu options to perform gateway configuration tasks. For more information, see Performing tasks on the virtual machine local console . Accessing the Gateway Local Console with VMware ESXi To access your gateway's local console with VMware ESXi 1. In the VMware vSphere client, select your gateway VM. 2. Make sure that the gateway VM is turned on. Accessing the Gateway Local Console with Linux KVM API Version 2013-06-30 190 AWS Storage Gateway Note Tape Gateway User Guide If your gateway VM is turned on, a green arrow icon appears with the VM icon in the VM browser panel on the left side of the application window. If your gateway VM is not turned on, you can turn it on by choosing the green Power On icon on the Toolbar at the top of the application window. 3. Choose the Console tab in the main
|
storagegateway-tgw-ug-076
|
storagegateway-tgw-ug.pdf
| 76 |
your gateway VM. 2. Make sure that the gateway VM is turned on. Accessing the Gateway Local Console with Linux KVM API Version 2013-06-30 190 AWS Storage Gateway Note Tape Gateway User Guide If your gateway VM is turned on, a green arrow icon appears with the VM icon in the VM browser panel on the left side of the application window. If your gateway VM is not turned on, you can turn it on by choosing the green Power On icon on the Toolbar at the top of the application window. 3. Choose the Console tab in the main information panel on the right side of the application window. After a few moments, the AWS Appliance gateway local console prompts you to login to change your network configuration and other settings. Note To release the cursor from the console window, press Ctrl+Alt. 4. Enter your username and password to log into the gateway local console. For more information, see Logging in to the Tape Gateway local console. After you log in, the AWS Appliance Activation - Configuration menu appears. You can select from the menu options to perform gateway configuration tasks. For more information, see Performing tasks on the virtual machine local console . Access the Gateway Local Console with Microsoft Hyper-V To access your gateway's local console (Microsoft Hyper-V) 1. Select your gateway appliance VM from the Virtual Machines panel on the left side of the Microsoft Hyper-V Manager application window. 2. Make sure that the gateway is turned on. Note If your gateway VM is turned on, Running is displayed in the State column for the VM in the Virtual Machines panel on the left side of the application window. If your Access the Gateway Local Console with Microsoft Hyper-V API Version 2013-06-30 191 AWS Storage Gateway Tape Gateway User Guide gateway VM is not turned on, you can turn it on by choosing Start in the Actions panel on the right side of the application window. 3. Choose Connect from the Actions panel. The Virtual Machine Connection window appears. If an authentication window appears, type the sign-in credentials provided to you by the hypervisor administrator. After a few moments, the AWS Appliance gateway local console prompts you to login to change your network configuration and other settings. 4. Enter your username and password to log into the gateway local console. For more information, see Logging in to the Tape Gateway local console. After you log in, the AWS Appliance Activation - Configuration menu appears. You can select from the menu options to perform gateway configuration tasks. For more information, see Performing tasks on the virtual machine local console . Performing Tasks on the VM Local Console For a Tape Gateway that you deploy on-premises, you can perform the following maintenance tasks using the gateway local console that you access from your virtual machine host platform. These tasks are common to VMware, Microsoft Hyper-V, and Linux Kernel-based Virtual Machine (KVM) hypervisors. Topics • Logging in to the Tape Gateway local console - Learn about how to log in to the gateway local console where you can configure gateway network settings and change the default password. • Configuring a SOCKS5 proxy for your on-premises gateway - Learn about how you can configure Storage Gateway to route all AWS endpoint traffic through a Socket Secure version 5 (SOCKS5) proxy server. • Configuring Your Gateway Network - Learn about how you can configure your gateway to use DHCP or assign a static IP address. • Testing your gateway connection to the internet - Learn about how you can use the gateway local console to test the connection between the gateway and the internet. Performing Tasks on the VM Local Console API Version 2013-06-30 192 AWS Storage Gateway Tape Gateway User Guide • Running storage gateway commands in the local console for an on-premises gateway - Learn about how to run local console commands that allow you to perform additional tasks such as saving routing tables, connecting to Support, and more. • Viewing your gateway system resource status - Learn about how to check the virtual CPU cores, root volume size, and RAM that are available to your gateway appliance. Logging in to the Tape Gateway 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 sign-in credentials to log in. These default login credentials give you access to menus where you can configure gateway network settings and change the password from the local console. Storage Gateway allows you to set your own password from the AWS Storage Gateway console instead of changing the password from the local console. You don't need to know the default password to
|
storagegateway-tgw-ug-077
|
storagegateway-tgw-ug.pdf
| 77 |
in to the Tape Gateway 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 sign-in credentials to log in. These default login credentials give you access to menus where you can configure gateway network settings and change the password from the local console. Storage Gateway allows you to set your own password from the AWS Storage Gateway console instead of changing the password from the local console. You don't need to know the default password to set a new password. For more information, see Setting the Local Console Password from the Storage Gateway Console. To log in to the gateway's local console • If this is your first time logging in to the local console, log in to the 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 by entering the corresponding numeral for Gateway Console from the AWS Appliance Activation - Configuration main menu, then running the passwd command. For information about how to run the command, see Running storage gateway commands in the local console for an on-premises gateway. You can also set your own password from the AWS Storage Gateway console. For more information, see Setting the Local Console Password from the Storage Gateway Console. Logging in to the Tape Gateway local console API Version 2013-06-30 193 AWS Storage Gateway Tape Gateway User Guide Important For older versions of the volume or Tape Gateway, the user name is sguser and the password is sgpassword. If you reset your password and your gateway is updated to a newer version, your the user name will change to admin but the password will be maintained. Setting the Local Console Password from the Storage Gateway Console When you log in to the local console for the first time, you log in to the VM with the default credentials— The user name is admin and the password is password. We recommend that you always set a new password immediately after you create your new gateway. You can set this password from the AWS Storage Gateway console rather than the local console if you want. You don't need to know the default password to set a new password. To set the local console password on the Storage Gateway console 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. On the navigation pane, choose Gateways then choose the gateway for which you want to set 3. 4. a new password. For Actions, choose Set Local Console Password. In the Set Local Console Password dialog box, type a new password, confirm the password and then choose Save. Your new password replaces the default password. Storage Gateway does not save the password but rather safely transmits it to the VM. Note The password can consist of any character on the keyboard and can be 1 to 512 characters long. Logging in to the Tape Gateway local console API Version 2013-06-30 194 AWS Storage Gateway Tape Gateway User Guide Configuring a SOCKS5 proxy for your on-premises gateway Volume Gateways and Tape Gateways support configuration of a Socket Secure version 5 (SOCKS5) proxy between your on-premises gateway and AWS. Note The only supported proxy configuration 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, Storage Gateway routes all traffic through your proxy server. For information about network requirements for your gateway, see Network and firewall requirements. The following procedure shows you how to configure SOCKS proxy for Volume Gateway and Tape Gateway. To configure a SOCKS5 proxy for volume and Tape Gateways 1. Log in to your gateway's local console. • VMware ESXi – for more information, see Accessing the Gateway Local Console with VMware ESXi. • Microsoft Hyper-V – for more information, see Access the Gateway Local Console with Microsoft Hyper-V. 2. 3. • KVM – for more information, see Accessing the Gateway Local Console with Linux KVM. From the AWS Storage Gateway - Configuration main menu, enter the corresponding numeral to select SOCKS Proxy Configuration. From the AWS Storage Gateway SOCKS Proxy Configuration menu, enter the corresponding numeral to perform one of the following tasks: To Perform This Task Do This Configure a SOCKS proxy Enter the corresponding numeral to select Configure SOCKS Proxy. Configuring a SOCKS5 proxy for your on-premises gateway API Version 2013-06-30 195 AWS Storage Gateway Tape Gateway User Guide To Perform This Task Do This View the
|
storagegateway-tgw-ug-078
|
storagegateway-tgw-ug.pdf
| 78 |
3. • KVM – for more information, see Accessing the Gateway Local Console with Linux KVM. From the AWS Storage Gateway - Configuration main menu, enter the corresponding numeral to select SOCKS Proxy Configuration. From the AWS Storage Gateway SOCKS Proxy Configuration menu, enter the corresponding numeral to perform one of the following tasks: To Perform This Task Do This Configure a SOCKS proxy Enter the corresponding numeral to select Configure SOCKS Proxy. Configuring a SOCKS5 proxy for your on-premises gateway API Version 2013-06-30 195 AWS Storage Gateway Tape Gateway User Guide To Perform This Task Do This View the current SOCKS proxy configura tion Remove a SOCKS proxy configuration You will need to supply a host name and port to complete configuration. Enter the corresponding numeral to select View Current SOCKS Proxy Configuration. If a SOCKS proxy is not configured, the message SOCKS Proxy not configure d is displayed. If a SOCKS proxy is configure d, the host name and port of the proxy are displayed. Enter the corresponding numeral to select Remove SOCKS Proxy Configuration. The message SOCKS Proxy Configura tion Removed is displayed. 4. Restart your VM to apply your HTTP configuration. Configuring Your Gateway Network The default network configuration for the gateway is Dynamic Host Configuration Protocol (DHCP). With DHCP, your gateway is automatically assigned an IP address. In some cases, you might need to manually assign your gateway's IP as a static IP address, as described following. To configure your gateway to use static IP addresses 1. Log in to your gateway's local console. • VMware ESXi – for more information, see Accessing the Gateway Local Console with VMware ESXi. • Microsoft Hyper-V – for more information, see Access the Gateway Local Console with Microsoft Hyper-V. • KVM – for more information, see Accessing the Gateway Local Console with Linux KVM. Configuring Your Gateway Network API Version 2013-06-30 196 AWS Storage Gateway Tape Gateway User Guide 2. 3. From the AWS Storage Gateway - Configuration main menu, enter the corresponding numeral to select Network Configuration. From the AWS Storage Gateway Network Configuration menu, perform one of the following tasks: To Perform This Task Do This Describe network adapter Enter the corresponding numeral to select Describe Adapter. 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 Gateway IP address DHCP activated status You use the adapter names listed here when you configure a static IP address or set your gateway's default adapter. Enter the corresponding numeral to select Configure DHCP. You are prompted to configure network interface to use DHCP. Configure DHCP Configuring Your Gateway Network API Version 2013-06-30 197 AWS Storage Gateway Tape Gateway User Guide To Perform This Task Do This Configure a static IP address for your gateway Enter the corresponding numeral to select Configure Static IP. You are prompted to type the following information to configure a static IP: • • • • • • Network adapter name IP address Netmask Default gateway address Primary Domain Name Service (DNS) address Secondary DNS address Important If your gateway has already been activated, you must shut it down and restart it from the Storage Gateway console for the settings to take effect. For more information, see Shutting Down Your Gateway VM. If your gateway uses more than one network interface, you must set all activated interfaces to use DHCP or static IP addresses. Configuring Your Gateway Network API Version 2013-06-30 198 AWS Storage Gateway Tape Gateway User Guide To Perform This Task Do This Configure a hostname for your gateway For example, suppose your gateway VM uses two interfaces configured as DHCP. If you later set one interface to a static IP, the other interface is deactivated. To activate 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 gateway to use DHCP, both interfaces will use DHCP. Enter the corresponding numeral to select Configure Hostname. You are prompted to choose whether the gateway will use a static hostname that you specify, or aquire one automatically through DCHP or rDNS. If you select Static, you are prompted to provide a static hostname, such as testgateway.example.com . Enter y to apply the configuration. Note If you configure a static hostname for your gateway, ensure that the provided hostname is in the domain that gateway is joined to. You must also create an A record in your DNS system that points the gateway's IP address to its static hostname. Configuring Your Gateway Network API Version 2013-06-30 199 AWS Storage Gateway
|
storagegateway-tgw-ug-079
|
storagegateway-tgw-ug.pdf
| 79 |
prompted to choose whether the gateway will use a static hostname that you specify, or aquire one automatically through DCHP or rDNS. If you select Static, you are prompted to provide a static hostname, such as testgateway.example.com . Enter y to apply the configuration. Note If you configure a static hostname for your gateway, ensure that the provided hostname is in the domain that gateway is joined to. You must also create an A record in your DNS system that points the gateway's IP address to its static hostname. Configuring Your Gateway Network API Version 2013-06-30 199 AWS Storage Gateway Tape Gateway User Guide To Perform This Task Do This Reset all your gateway's network configuration to DHCP Set your gateway's default route adapter View your gateway's DNS configuration View routing tables Enter the corresponding numeral to select Reset all to DHCP. All network interfaces are set to use DHCP. Important If your gateway has already been activated, you must shut down and restart your gateway from the Storage Gateway console for the settings to take effect. For more information, see Shutting Down Your Gateway VM. Enter the corresponding numeral to select Set Default Adapter. The available adapters for your gateway are shown, and you are prompted to select one of the adapters—for example, eth0. Enter the corresponding numeral to select View DNS Configuration. The IP addresses of the primary and secondary DNS name servers are displayed. Enter the corresponding numeral to select View Routes. The default route of your gateway is displayed. Configuring Your Gateway Network API Version 2013-06-30 200 AWS Storage Gateway Tape Gateway User Guide Testing your gateway connection 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. • VMware ESXi – for more information, see Accessing the Gateway Local Console with VMware ESXi. • Microsoft Hyper-V – for more information, see Access the Gateway Local Console with Microsoft Hyper-V. • KVM – for more information, see Accessing the Gateway Local Console with Linux KVM. 2. From the AWS Storage Gateway - 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 [PASSED] [FAILED] Description Storage Gateway has network connectivity. Storage Gateway does not have network connectivity. Testing your gateway connectivity to the internet API Version 2013-06-30 201 AWS Storage Gateway Tape Gateway User Guide Running storage gateway commands in the local console for an on- premises gateway The VM local console in Storage Gateway helps provide a secure environment for configuring and diagnosing issues with your gateway. Using the local console commands, you can perform maintenance tasks such as saving routing tables, connecting to Support, and so on. To run a configuration or diagnostic command 1. Log in to your gateway's local console: • For more information on logging in to the VMware ESXi local console, see Accessing the Gateway Local Console with VMware ESXi. • For more information on logging in to the Microsoft Hyper-V local console, see Access the Gateway Local Console with Microsoft Hyper-V. • For more information on logging in to the KVM local console, see Accessing the Gateway Local Console with Linux KVM. 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 exit h Collect output from dig for DNS troublesh ooting. Return to Configuration menu. Display available command list. ifconfig View or configure network interfaces. Running storage gateway commands in the local console for an on-premises gateway API Version 2013-06-30 202 Note We recommend configuring network or IP settings using the Storage AWS Storage Gateway Command Tape Gateway User Guide Function Gateway console or the dedicated local console menu option. For instructions, see Configuring Your Gateway Network. ip Show / manipulate routing, devices,
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.