Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
storagegateway-tgw-ug-080	storagegateway-tgw-ug.pdf	80	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 Conﬁguration menu. Display available command list. ifconﬁg View or conﬁgure network interfaces. Running storage gateway commands in the local console for an on-premises gateway API Version 2013-06-30 202 Note We recommend conﬁguring 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 Conﬁguring Your Gateway Network. ip Show / manipulate routing, devices, and tunnels. Note We recommend conﬁguring network or IP settings using the Storage Gateway console or the dedicated local console menu option. For instructions, see Conﬁguring Your Gateway Network. Administration tool for IPv4 packet ﬁltering and NAT. Test connectivity to a speciﬁc TCP port on a network. Collect output from nping for network t roubleshooting. iptables ncport nping open-support-channel Connect to AWS Support. passwd save-iptables Update authentication tokens. Persist IP tables. save-routing-table Save newly added routing table entry. Running storage gateway commands in the local console for an on-premises gateway API Version 2013-06-30 203 AWS Storage Gateway Tape Gateway User Guide Command sslcheck Function Returns output with certiﬁcate issuer Note Storage Gateway uses certiﬁca te issuer veriﬁcation and does not support ssl inspection. If this command returns an issuer other than aws-appliance@amazon.com, then it is likely that an application performing an ssl inspection. In that case, we recommend bypassing ssl inspection for the Storage Gateway appliance. tcptraceroute Collect traceroute output on TCP traﬃc to a destination. 4. From the gateway console command prompt, enter the corresponding command for the function you want to use, and follow the instructions. To learn about a command, enter man + command name at the command prompt. Viewing your gateway system resource status When your gateway starts, it checks its virtual CPU cores, root volume size, and RAM. It then determines whether these system resources are suﬃcient for your gateway to function properly. You can view the results of this check on the gateway's local console. To view the status of a system resource check 1. Log in to your gateway's local console: • For more information on logging in to the VMware ESXi console, see Accessing the Gateway Local Console with VMware ESXi. Viewing your gateway system resource status API Version 2013-06-30 204 AWS Storage Gateway Tape Gateway User Guide • 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 - Conﬁguration main menu, enter the corresponding numeral to select View System Resource Check. Each resource displays [OK], [WARNING], or [FAIL], indicating the status of the resource as follows: Message [OK] [WARNING] [FAIL] Description The resource has passed the system resource check. The resource doesn't meet the recommended requirements, but your gateway can continue to function. Storage Gateway displays a message that describes the results of the resource check. The resource doesn't meet the minimum requirements. Your gateway might not function properly. Storage Gateway displays a message that describes the results of the resource check. The console also displays the number of errors and warnings next to the resource check menu option. Performing Tasks on the Amazon EC2 Local Console Some Storage Gateway maintenance tasks require that you log in to the gateway local console for a gateway that you have deployed on an Amazon EC2 instance. You can access the gateway local console on your Amazon EC2 instance by using a Secure Shell (SSH) client. The topics in this section describes how to log in to the gateway local console and perform maintenance tasks. Performing Tasks on the EC2 Local Console API Version 2013-06-30 205 AWS Storage Gateway Topics Tape Gateway User Guide • Logging In to Your Amazon EC2 Gateway Local Console - Learn about how you can connect and log in to the gateway local console your Amazon EC2 instance by using a Secure Shell (SSH) client. • Routing your gateway deployed on EC2 through an HTTP proxy - Learn about how you can conﬁgure Storage Gateway to route all AWS enpoint traﬃc through a Socket Secure version 5 (SOCKS5) proxy server to your Amazon EC2 gateway instance. • Testing gateway network connectivity - Learn about how you can use the gateway local console to test network connectivity between your gateway and various network resources. • Viewing your gateway system resource status - Learn about how you can use the gateway local console to check the virtual CPU cores, root volume size, and RAM that are available to your gateway appliance. •
storagegateway-tgw-ug-081	storagegateway-tgw-ug.pdf	81	on EC2 through an HTTP proxy - Learn about how you can conﬁgure Storage Gateway to route all AWS enpoint traﬃc through a Socket Secure version 5 (SOCKS5) proxy server to your Amazon EC2 gateway instance. • Testing gateway network connectivity - Learn about how you can use the gateway local console to test network connectivity between your gateway and various network resources. • Viewing your gateway system resource status - Learn about how you can use the gateway local console to check the virtual CPU cores, root volume size, and RAM that are available to your gateway appliance. • Running Storage Gateway commands on the local console - Learn about how you can run local console commands that allow you to perform additional tasks such as saving routing tables, connecting to Support, and more. Logging In to Your Amazon EC2 Gateway Local Console You can connect to your Amazon EC2 instance by using a Secure Shell (SSH) client. For detailed information, see Connect to Your Instance in the Amazon EC2 User Guide. To connect this way, you will need the SSH key pair you speciﬁed when you launched the instance. For information about Amazon EC2 key pairs, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide. To log in to the gateway local console 1. Log in to your local console. If you are connecting to your EC2 instance from a Windows computer, log in as admin. 2. After you log in, you see the AWS Storage Gateway - Conﬁguration main menu, from which you can perform various tasks. To Learn About This Task See This Topic Conﬁgure a SOCKS proxy for your gateway Routing your gateway deployed on EC2 through an HTTP proxy Logging In to Your EC2 Gateway Local Console API Version 2013-06-30 206 AWS Storage Gateway Tape Gateway User Guide To Learn About This Task See This Topic Test network connectivity Testing gateway network connectivity Run Storage Gateway console commands View a system resource check Running Storage Gateway commands on the local console Viewing your gateway system resource statu s. To shut down the gateway, enter 0. To exit the conﬁguration session, enter X. Routing your gateway deployed on EC2 through an HTTP proxy Storage Gateway supports the conﬁguration of a Socket Secure version 5 (SOCKS5) proxy between your gateway deployed on Amazon EC2 and AWS. If your gateway must use a proxy server to communicate to the internet, then you need to conﬁgure the HTTP proxy settings for your gateway. You do this by specifying an IP address and port number for the host running your proxy. After you do so, Storage Gateway routes all AWS endpoint traﬃc through your proxy server. Communications between the gateway and endpoints is encrypted, even when using the HTTP proxy. To route your gateway internet traﬃc through a local proxy server 1. Log in to your gateway's local console. For instructions, see Logging In to Your Amazon EC2 Gateway Local Console. 2. 3. From the AWS Appliance Activation - Conﬁguration main menu, enter the corresponding numeral to select Conﬁgure HTTP Proxy. From the AWS Appliance Activation HTTP Proxy Conﬁguration menu, enter the corresponding numeral for the task you want to perform: • Conﬁgure HTTP proxy - You will need to supply a host name and port to complete conﬁguration. Conﬁguring an HTTP proxy API Version 2013-06-30 207 AWS Storage Gateway Tape Gateway User Guide • View current HTTP proxy conﬁguration - If an HTTP proxy is not conﬁgured, the message HTTP Proxy not configured is displayed. If an HTTP proxy is conﬁgured, the host name and port of the proxy are displayed. • Remove an HTTP proxy conﬁguration - The message HTTP Proxy Configuration Removed is displayed. Testing gateway network connectivity You can use your gateway's local console to test your network connectivity. This test can be useful when you are troubleshooting network issues with your gateway. To test your gateway's connectivity 1. Log in to your gateway's local console. For instructions, see Logging In to Your Amazon EC2 Gateway Local Console. 2. From the AWS Appliance Activation - Conﬁguration 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.
storagegateway-tgw-ug-082	storagegateway-tgw-ug.pdf	82	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] Description Storage Gateway has network connectivity. Testing gateway network connectivity API Version 2013-06-30 208 AWS Storage Gateway Tape Gateway User Guide Message [FAILED] Description Storage Gateway does not have network connectivity. Viewing your gateway system resource status When your gateway starts, it checks its virtual CPU cores, root volume size, and RAM. It then determines whether these system resources are suﬃcient for your gateway to function properly. You can view the results of this check on the gateway's local console. To view the status of a system resource check 1. Log in to your gateway's local console. For instructions, see Logging In to Your Amazon EC2 Gateway Local Console. 2. From the AWS Appliance Activation - Conﬁguration main menu, enter the corresponding numeral to select View System Resource Check. Each resource displays [OK], [WARNING], or [FAIL], indicating the status of the resource as follows: Message [OK] [WARNING] [FAIL] Description The resource has passed the system resource check. The resource doesn't meet the recommended requirements, but your gateway can continue to function. Storage Gateway displays a message that describes the results of the resource check. The resource doesn't meet the minimum requirements. Your gateway might not function properly. Storage Gateway displays a message that describes the results of the resource check. Viewing your gateway system resource status API Version 2013-06-30 209 AWS Storage Gateway Tape Gateway User Guide The console also displays the number of errors and warnings next to the resource check menu option. Running Storage Gateway commands on the local console The AWS Storage Gateway console helps provide a secure environment for conﬁguring and diagnosing issues with your gateway. Using the console commands, you can perform maintenance tasks such as saving routing tables or connecting to Support. To run a conﬁguration or diagnostic command 1. Log in to your gateway's local console. For instructions, see Logging In to Your Amazon EC2 Gateway Local Console. 2. From the AWS Appliance Activation - Conﬁguration 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 Conﬁguration menu. Display available command list. ifconﬁg View or conﬁgure network interfaces. Note We recommend conﬁguring network or IP settings using the Storage Gateway console or the dedicated local console menu option. Running Storage Gateway commands on the local console API Version 2013-06-30 210 AWS Storage Gateway Tape Gateway User Guide Command ip iptables ncport nping Function Show / manipulate routing, devices, and tunnels. Note We recommend conﬁguring network or IP settings using the Storage Gateway console or the dedicated local console menu option. Administration tool for IPv4 packet ﬁltering and NAT. Test connectivity to a speciﬁc TCP port on a network. Collect output from nping for network t roubleshooting. open-support-channel Connect to AWS Support. save-iptables Persist IP tables. save-routing-table Save newly added routing table entry. sslcheck tcptraceroute Check SSL validity for network troublesh ooting. Collect traceroute output on TCP traﬃc to a destination. 4. From the gateway console command prompt, enter the corresponding command for the function you want to use, and follow the instructions. To learn about a command, enter the command name followed by the -h option, for example: sslcheck -h. Running Storage Gateway commands on the local console API Version 2013-06-30 211 AWS Storage Gateway Tape Gateway User Guide Performance and optimization for Tape Gateway This section describes Storage Gateway performance. Topics • Performance guidance for Tape Gateways • Optimizing gateway performance Performance guidance for Tape Gateways In this section, you can ﬁnd conﬁguration guidance for provisioning hardware for your Tape Gateway VM. The Amazon EC2 instance sizes and types that are listed in the table are examples, and are provided for reference. Conﬁguration Write Throughpu t Gbps Read from Cache Throughput Gbps Read from Amazon Web Services Cloud Throughput Gbps 2.3 4.0 2.2 Host Platform: Amazon EC2 instance— c5.4xlarge CPU: 16 vCPU \| RAM: 32 GB Root disk: 80 GB, io1 SSD, 4,000 IOPS Cache
storagegateway-tgw-ug-083	storagegateway-tgw-ug.pdf	83	section describes Storage Gateway performance. Topics • Performance guidance for Tape Gateways • Optimizing gateway performance Performance guidance for Tape Gateways In this section, you can ﬁnd conﬁguration guidance for provisioning hardware for your Tape Gateway VM. The Amazon EC2 instance sizes and types that are listed in the table are examples, and are provided for reference. Conﬁguration Write Throughpu t Gbps Read from Cache Throughput Gbps Read from Amazon Web Services Cloud Throughput Gbps 2.3 4.0 2.2 Host Platform: Amazon EC2 instance— c5.4xlarge CPU: 16 vCPU \| RAM: 32 GB Root disk: 80 GB, io1 SSD, 4,000 IOPS Cache disk: striped RAID (2 x 500 GB, io1 EBS SSD, 25000 IOPs) Upload buﬀer disk: 450 GB, io1 SSD, 2000 IOPs Network bandwidth to cloud: 10 Gbps Performance guidance for Tape Gateways API Version 2013-06-30 212 AWS Storage Gateway Conﬁguration Tape Gateway User Guide Write Throughpu t Gbps Read from Cache Throughput Gbps Read from Amazon Web Services Cloud Throughput Gbps Host platform: Storage Gateway Hardware Appliance 2.3 8.8 3.8 5.2 11.6 5.2 Cache disk: 2.5 TB Upload buﬀer disk: 2 TB Network bandwidth to cloud: 10 Gbps Host platform: Amazon EC2instance— c5d.9xlarge CPU: 36 vCPU \| RAM: 72 GB Root disk: 80 GB, io1 SSD, 4,000 IOPS Cache disk: 900 GB NVMe disk Upload buﬀer disk: 900 GB NVMe disk Network bandwidth to cloud: 10 Gbps Performance guidance for Tape Gateways API Version 2013-06-30 213 Tape Gateway User Guide Write Throughpu t Gbps Read from Cache Throughput Gbps Read from Amazon Web Services Cloud Throughput Gbps 5.2 11.6 7.2 AWS Storage Gateway Conﬁguration Host platform: Amazon EC2instance— c5d.metal CPU: 96 vCPU \| RAM: 192 GB Root disk: 80 GB, io1 SSD, 4,000 IOPS Cache disk: striped RAID (2 x 900 GB NVMe disk) Upload buﬀer disk: 900 GB NVMe disk Network bandwidth to cloud: 10 Gbps Note This performance was achieved by using a 1 MB block size and ten tape drives simultaneously. The EC2 conﬁgurations in the above table are only intended to be representative of the performance you might attain on your own physical servers with similar resources. For example, the EC2 conﬁgurations using a striped RAID were done through a special mechanism that is not generally supported by our gateway on EC2. To achieve similar performance, you should instead use a hardware RAID controller attached to the on- premise server running your gateway. Your performance might vary based on your host platform conﬁguration and network bandwidth. Performance guidance for Tape Gateways API Version 2013-06-30 214 AWS Storage Gateway Tape Gateway User Guide To improve write and read throughput performance of your Tape Gateway, see Optimize iSCSI Settings, Use a Larger Block Size for Tape Drives, and Optimize the Performance of Virtual Tape Drives in the Backup Software. Optimizing gateway performance Recommended Gateway Server Conﬁguration To obtain the best performance out of your gateway, Storage Gateway recommends the following gateway conﬁguration for your gateway's host server: • At least 64 dedicated physical CPU cores • For Tape Gateway, your hardware should dedicate the following amounts of RAM: • At least 16 GiB of reserved RAM for gateways with cache size up to 16 TiB • At least 32 GiB of reserved RAM for gateways with cache size 16 TiB to 32 TiB • At least 48 GiB of reserved RAM for gateways with cache size 32 TiB to 64 TiB Note For optimal gateway performance, you must provision at least 32 GiB of RAM. • Disk 1, to be used as the gateway cache as follows: • Striped RAID (redundant array of independent disks) consisting of NVMe SSDs. • Disk 2, to be used as the gateway upload buﬀer as follows: • Striped RAID consisting of NVMe SSDs. • Disk 3, to be used as the gateway upload buﬀer as follows: • Striped RAID consisting of NVMe SSDs. • Network adapter 1 conﬁgured on VM network 1: • Use VM network 1 and add VMXnet3 (10 Gbps) to be used for ingestion. • Network adapter 2 conﬁgured on VM network 2: • Use VM network 2 and add a VMXnet3 (10 Gbps) to be used to connect to AWS. Optimizing gateway performance API Version 2013-06-30 215 AWS Storage Gateway Tape Gateway User Guide Add Resources to Your Gateway The following bottlenecks can reduce the performance of your Tape Gateway below the theoretical maximum sustained throughput (your bandwidth to AWS cloud): • CPU core count • Cache/Upload buﬀer disk throughput • Total RAM amount • Network bandwidth to AWS • Network bandwidth from initiator to gateway This section contains steps you can take in order to optimize the performance of your gateway. This guidance is based on adding resources to your gateway or your application server. You can optimize gateway performance by adding resources to your gateway in
storagegateway-tgw-ug-084	storagegateway-tgw-ug.pdf	84	Storage Gateway Tape Gateway User Guide Add Resources to Your Gateway The following bottlenecks can reduce the performance of your Tape Gateway below the theoretical maximum sustained throughput (your bandwidth to AWS cloud): • CPU core count • Cache/Upload buﬀer disk throughput • Total RAM amount • Network bandwidth to AWS • Network bandwidth from initiator to gateway This section contains steps you can take in order to optimize the performance of your gateway. This guidance is based on adding resources to your gateway or your application server. You can optimize gateway performance by adding resources to your gateway in one or more of the following ways. Use higher-performance disks Cache and upload buﬀer disk throughput can limit your gateway's upload and download performance. If your gateway is exhibiting performance signiﬁcantly below what is expected, consider improving the cache and upload buﬀer disk throughput by: • Using a striped RAID such as RAID 10 to improve disk throughput, ideally with a hardware RAID controller. Note RAID (redundant array of independent disks) or speciﬁcally disk striped RAID conﬁgurations like RAID 10, is the process of dividing a body of data into blocks and spreading the data blocks across multiple storage devices. The RAID level you use aﬀects the exact speed and fault tolerance you can achieve. By striping IO workloads out across multiple disks, the overall throughput of the RAID device is much higher than that of any single member disk. • Using directly attached, high performance disks To optimize gateway performance, you can add high-performance disks such as solid-state drives (SSDs) and a NVMe controller. You can also attach virtual disks to your VM directly Add Resources to Your Gateway API Version 2013-06-30 216 AWS Storage Gateway Tape Gateway User Guide from a storage area network (SAN) instead of the Microsoft Hyper-V NTFS. Improved disk performance generally results in better throughput and more input/output operations per second (IOPS). To measure throughput, use the ReadBytes and WriteBytes metrics with the Samples Amazon CloudWatch statistic. For example, the Samples statistic of the ReadBytes metric over a sample period of 5 minutes divided by 300 seconds gives you the IOPS. As a general rule, when you review these metrics for a gateway, look for low throughput and low IOPS trends to indicate disk-related bottlenecks. For more information about gateway metrics, see Measuring Performance Between Your Tape Gateway and AWS. Note CloudWatch metrics are not available for all gateways. For information about gateway metrics, see Monitoring Storage Gateway. Add more upload buﬀer disks To achieve higher write throughput, add at least two upload buﬀer disks. When data is written to the gateway, it is written and stored locally on the upload buﬀer disks. Afterwards, the stored local data is asynchronously read from the disks to be processed and uploaded to AWS. Adding more upload buﬀer disks may reduce the amount of concurrent I/O operations performed to each individual disk. This can result in increased write throughput to the gateway. Back gateway virtual disks with separate physical disks When you provision gateway disks, we strongly recommend that you don't provision local disks for the upload buﬀer and cache storage that use the same underlying physical storage disk. For example, for VMware ESXi, the underlying physical storage resources are represented as a data store. When you deploy the gateway VM, you choose a data store on which to store the VM ﬁles. When you provision a virtual disk (for example, as an upload buﬀer), you can store the virtual disk in the same data store as the VM or a diﬀerent data store. If you have more than one data store, then we strongly recommend that you choose one data store for each type of local storage you are creating. A data store that is backed by only one underlying physical disk can lead to poor performance. An example is when you use such a disk to back both the cache storage and upload buﬀer in a gateway setup. Similarly, a data store that is backed by a less high-performing RAID conﬁguration such as RAID 1 or RAID 6 can lead to poor performance. Add Resources to Your Gateway API Version 2013-06-30 217 AWS Storage Gateway Tape Gateway User Guide Add CPU resources to your gateway host The minimum requirement for a gateway host server is four virtual processors. To optimize gateway performance, conﬁrm that each virtual processor that is assigned to the gateway VM is backed by a dedicated CPU core. In addition, conﬁrm that you are not oversubscribing the CPUs of the host server. When you add additional CPUs to your gateway host server, you increase the processing capability of the gateway. Doing this allows your gateway to deal with, in parallel, both storing data from your application to your local storage and uploading
storagegateway-tgw-ug-085	storagegateway-tgw-ug.pdf	85	Tape Gateway User Guide Add CPU resources to your gateway host The minimum requirement for a gateway host server is four virtual processors. To optimize gateway performance, conﬁrm that each virtual processor that is assigned to the gateway VM is backed by a dedicated CPU core. In addition, conﬁrm that you are not oversubscribing the CPUs of the host server. When you add additional CPUs to your gateway host server, you increase the processing capability of the gateway. Doing this allows your gateway to deal with, in parallel, both storing data from your application to your local storage and uploading this data to Amazon S3. Additional CPUs also help ensure that your gateway gets enough CPU resources when the host is shared with other VMs. Providing enough CPU resources has the general eﬀect of improving throughput. Increase bandwidth between your gateway and AWS cloud Increasing your bandwidth to and from AWS will increase the maximum rate of data ingress to your gateway and egress to AWS cloud. This can improve your gateway performance if network speed is the limiting factor in your gateway conﬁguration, rather than other factors like slow disks or poor gateway-initiator connection bandwidth. Network bandwidth to and from AWS deﬁnes the theoretical maximum average performance of your Tape Gateway during sustained workloads. • The average rate at which you can write data to your Tape Gateway over long intervals will not exceed your upload bandwidth to AWS. • The average rate at which you can read data from your Tape Gateway over long intervals will not exceed your download bandwidth to AWS. Note Your observed gateway performance will likely be lower than your network bandwidth due to other limiting factors listed here, such as cache/upload buﬀer disk throughput, CPU core count, total RAM amount, or the bandwidth between your initiator and gateway. Furthermore, your gateway's normal operation involves many actions taken to protect your data, which might cause the observed performance to be less than your network bandwidth. Add Resources to Your Gateway API Version 2013-06-30 218 AWS Storage Gateway Tape Gateway User Guide Optimize iSCSI Settings You can optimize iSCSI settings on your iSCSI initiator to achieve higher I/O performance. We recommend choosing 256 KiB for MaxReceiveDataSegmentLength and FirstBurstLength, and 1 MiB for MaxBurstLength. For more information about conﬁguring iSCSI settings, see Customizing iSCSI Settings. Note These recommended settings can facilitate overall better performance. However, the speciﬁc iSCSI settings that are needed to optimize performance vary depending on which backup software you use. For details, see your backup software documentation. Use a Larger Block Size for Tape Drives For a Tape Gateway, the default block size for a tape drive is 64 KB. However, you can increase the block size up to 1 MB to improve I/O performance. The block size that you choose depends on the maximum block size that your backup software supports. We recommend that you set the block size of the tape drives in your backup software to a size that is as large as possible. However, this block size must not be greater than the 1 MB maximum size that the gateway supports. Tape Gateways negotiate the block size for virtual tape drives to automatically match what is set on the backup software. When you increase the block size on the backup software, we recommend that you also check the settings to ensure that the host initiator supports the new block size. For more information, see the documentation for your backup software. For more information about speciﬁc gateway performance guidance, see Performance and optimization for Tape Gateway. Optimize the Performance of Virtual Tape Drives in the Backup Software Your backup software can back up data on up to 10 virtual tape drives on a Tape Gateway at the same time. We recommend that you conﬁgure backup jobs in your backup software to use at least 4 virtual tape drives simultaneously on the Tape Gateway. You can achieve better write throughput when the backup software is backing up data to more than one virtual tape at the same time. Optimize iSCSI Settings API Version 2013-06-30 219 AWS Storage Gateway Tape Gateway User Guide As a general rule, you can achieve a higher maximum throughput by operating on (reading or writing from) more virtual tapes at the same time. By using more tape drives, you allow your gateway to service more requests concurrently, potentially improving performance. Add Resources to Your Application Environment Increase the bandwidth between your application server and your gateway The connection between your iSCSI initiator and gateway can limit your upload and download performance. If your gateway is exhibiting performance signiﬁcantly worse than expected and you have already improved your CPU core count and disk throughput, consider: • Upgrading your network cables to have higher bandwidth between your initiator and
storagegateway-tgw-ug-086	storagegateway-tgw-ug.pdf	86	maximum throughput by operating on (reading or writing from) more virtual tapes at the same time. By using more tape drives, you allow your gateway to service more requests concurrently, potentially improving performance. Add Resources to Your Application Environment Increase the bandwidth between your application server and your gateway The connection between your iSCSI initiator and gateway can limit your upload and download performance. If your gateway is exhibiting performance signiﬁcantly worse than expected and you have already improved your CPU core count and disk throughput, consider: • Upgrading your network cables to have higher bandwidth between your initiator and gateway. • Using as many tape drives concurrently as possible. iSCSI does not support queueing multiple requests for the same target, meaning that the more tape drives you use, the more requests that your gateway can service concurrently. This will allow you to more fully utilize the bandwidth between your gateway and initiator, increasing your gateway's apparent throughput. To optimize gateway performance, ensure that the network bandwidth between your application and the gateway can sustain your application needs. You can use the ReadBytes and WriteBytes metrics of the gateway to measure the total data throughput. For more information about these metrics, see Measuring Performance Between Your Tape Gateway and AWS. For your application, compare the measured throughput with the desired throughput. If the measured throughput is less than the desired throughput, then increasing the bandwidth between your application and gateway can improve performance if the network is the bottleneck. Similarly, you can increase the bandwidth between your VM and your local disks, if they're not direct-attached. Add CPU resources to your application environment If your application can use additional CPU resources, then adding more CPUs can help your application to scale its I/O load. Add Resources to Your Application Environment API Version 2013-06-30 220 AWS Storage Gateway Tape Gateway User Guide Security in AWS Storage Gateway Cloud security at AWS is the highest priority. As an AWS customer, you beneﬁt from a data center and network architecture that is built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the Amazon Web Services Cloud. AWS also provides you with services that you can use securely. Third-party auditors regularly test and verify the eﬀectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to AWS Storage Gateway, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors including the sensitivity of your data, your company’s requirements, and applicable laws and regulations. This documentation helps you understand how to apply the shared responsibility model when using Storage Gateway. The following topics show you how to conﬁgure Storage Gateway to meet your security and compliance objectives. You also learn how to use other AWS services that help you to monitor and secure your Storage Gateway resources. Topics • Data protection in AWS Storage Gateway • Identity and Access Management for AWS Storage Gateway • Compliance validation for AWS Storage Gateway • Resilience in AWS Storage Gateway • Infrastructure Security in AWS Storage Gateway • AWS Security Best Practices • Logging and Monitoring in AWS Storage Gateway API Version 2013-06-30 221 AWS Storage Gateway Tape Gateway User Guide Data protection in AWS Storage Gateway The AWS shared responsibility model applies to data protection in AWS Storage Gateway. As described in this model, AWS is responsible for protecting the global infrastructure that runs all of the AWS Cloud. You are responsible for maintaining control over your content that is hosted on this infrastructure. You are also responsible for the security conﬁguration and management tasks for the AWS services that you use. For more information about data privacy, see the Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulﬁll their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS 1.2 and recommend TLS 1.3. • Set up API and user activity logging with AWS CloudTrail. For information about using CloudTrail trails
storagegateway-tgw-ug-087	storagegateway-tgw-ug.pdf	87	AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulﬁll their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS 1.2 and recommend TLS 1.3. • Set up API and user activity logging with AWS CloudTrail. For information about using CloudTrail trails to capture AWS activities, see Working with CloudTrail trails in the AWS CloudTrail User Guide. • Use AWS encryption solutions, along with all default security controls within AWS services. • Use advanced managed security services such as Amazon Macie, which assists in discovering and securing sensitive data that is stored in Amazon S3. • If you require FIPS 140-3 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-3. We strongly recommend that you never put conﬁdential or sensitive information, such as your customers' email addresses, into tags or free-form text ﬁelds such as a Name ﬁeld. This includes when you work with Storage Gateway or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text ﬁelds used for names may be used for billing or diagnostic logs. If you provide a URL to an external server, we strongly recommend that you do not include credentials information in the URL to validate your request to that server. Data protection API Version 2013-06-30 222 AWS Storage Gateway Tape Gateway User Guide Data encryption using AWS KMS Storage Gateway uses SSL/TLS (Secure Socket Layers/Transport Layer Security) to encrypt data that is transferred between your gateway appliance and AWS storage. By default, Storage Gateway uses Amazon S3-Managed Encryption Keys (SSE-S3) to server-side encrypt all data it stores in Amazon S3. You have an option to use the Storage Gateway API to conﬁgure your gateway to encrypt data stored in the cloud using server-side encryption with AWS Key Management Service (SSE-KMS) keys. Important When you use an AWS KMS key for server-side encryption, you must choose a symmetric key. Storage Gateway does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the AWS Key Management Service Developer Guide. Encrypting a ﬁle share For a ﬁle share, you can conﬁgure your gateway to encrypt your objects with AWS KMS–managed keys by using SSE-KMS. For information on using the Storage Gateway API to encrypt data written to a ﬁle share, see CreateNFSFileShare in the AWS Storage Gateway API Reference. Encrypting a volume For cached and stored volumes, you can conﬁgure your gateway to encrypt volume data stored in the cloud with AWS KMS–managed keys by using the Storage Gateway API. You can specify one of the managed keys as the KMS key. The key that you use to encrypt your volume can't be changed after the volume is created. For information on using the Storage Gateway API to encrypt data written to a cached or stored volume, see CreateCachediSCSIVolume or CreateStorediSCSIVolume in the AWS Storage Gateway API Reference. Encrypting a tape For a virtual tape, you can conﬁgure your gateway to encrypt tape data stored in the cloud with AWS KMS–managed keys by using the Storage Gateway API. You can specify one of the managed keys as the KMS key. The key that you use to encrypt your tape data can't be changed after the tape is created. For information on using the Storage Gateway API to encrypt data written to a virtual tape, see CreateTapes in the AWS Storage Gateway API Reference. When using AWS KMS to encrypt your data, keep the following in mind: Data encryption API Version 2013-06-30 223 AWS Storage Gateway Tape Gateway User Guide • Your data is encrypted at rest in the cloud. That is, the data is encrypted in Amazon S3. • IAM users must have the required permissions to call the AWS KMS API operations. For more information, see Using IAM policies with AWS KMS in the AWS Key Management Service Developer Guide. • If you delete or deactivate your AWS AWS KMS key or revoke the grant token, you can't access the data on the volume or tape. For more information, see Deleting KMS keys in the AWS Key Management Service Developer Guide. • If you create a snapshot from a volume that is KMS-encrypted, the snapshot is encrypted. The snapshot inherits the volume's KMS key. • If you create a new volume from a snapshot that
storagegateway-tgw-ug-088	storagegateway-tgw-ug.pdf	88	to call the AWS KMS API operations. For more information, see Using IAM policies with AWS KMS in the AWS Key Management Service Developer Guide. • If you delete or deactivate your AWS AWS KMS key or revoke the grant token, you can't access the data on the volume or tape. For more information, see Deleting KMS keys in the AWS Key Management Service Developer Guide. • If you create a snapshot from a volume that is KMS-encrypted, the snapshot is encrypted. The snapshot inherits the volume's KMS key. • If you create a new volume from a snapshot that is KMS-encrypted, the volume is encrypted. You can specify a diﬀerent KMS key for the new volume. Note Storage Gateway doesn't support creating an unencrypted volume from a recovery point of a KMS-encrypted volume or a KMS-encrypted snapshot. For more information about AWS KMS, see What is AWS Key Management Service? Identity and Access Management for AWS Storage Gateway AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use AWS SGW resources. IAM is an AWS service that you can use with no additional charge. Topics • Audience • Authenticating with identities • Managing access using policies • How AWS Storage Gateway works with IAM • Identity-based policy examples for Storage Gateway • Troubleshooting AWS Storage Gateway identity and access Identity and Access Management API Version 2013-06-30 224 AWS Storage Gateway Audience Tape Gateway User Guide How you use AWS Identity and Access Management (IAM) diﬀers, depending on the work that you do in AWS SGW. Service user – If you use the AWS SGW service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more AWS SGW features to do your work, you might need additional permissions. Understanding how access is managed can help you request the right permissions from your administrator. If you cannot access a feature in AWS SGW, see Troubleshooting AWS Storage Gateway identity and access. Service administrator – If you're in charge of AWS SGW resources at your company, you probably have full access to AWS SGW. It's your job to determine which AWS SGW features and resources your service users should access. You must then submit requests to your IAM administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with AWS SGW, see How AWS Storage Gateway works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to AWS SGW. To view example AWS SGW identity-based policies that you can use in IAM, see Identity-based policy examples for Storage Gateway. Authenticating with identities Authentication is how you sign in to AWS using your identity credentials. You must be authenticated (signed in to AWS) as the AWS account root user, as an IAM user, or by assuming an IAM role. You can sign in to AWS as a federated identity by using credentials provided through an identity source. AWS IAM Identity Center (IAM Identity Center) users, your company's single sign-on authentication, and your Google or Facebook credentials are examples of federated identities. When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If Audience API Version 2013-06-30 225 AWS Storage Gateway Tape Gateway User Guide you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one sign-in identity that has
storagegateway-tgw-ug-089	storagegateway-tgw-ug.pdf	89	information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in the account. This identity is called the AWS account root user and is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you don't use the root user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. For the complete list of tasks that require you to sign in as the root user, see Tasks that require root user credentials in the IAM User Guide. Federated identity As a best practice, require human users, including users that require administrator access, to use federation with an identity provider to access AWS services by using temporary credentials. A federated identity is a user from your enterprise user directory, a web identity provider, the AWS Directory Service, the Identity Center directory, or any user that accesses AWS services by using credentials provided through an identity source. When federated identities access AWS accounts, they assume roles, and the roles provide temporary credentials. For centralized access management, we recommend that you use AWS IAM Identity Center. You can create users and groups in IAM Identity Center, or you can connect and synchronize to a set of users and groups in your own identity source for use across all your AWS accounts and applications. For information about IAM Identity Center, see What is IAM Identity Center? in the AWS IAM Identity Center User Guide. IAM users and groups An IAM user is an identity within your AWS account that has speciﬁc permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating Authenticating with identities API Version 2013-06-30 226 AWS Storage Gateway Tape Gateway User Guide IAM users who have long-term credentials such as passwords and access keys. However, if you have speciﬁc use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. An IAM group is an identity that speciﬁes a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are diﬀerent from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. IAM roles An IAM role is an identity within your AWS account that has speciﬁc permissions. It is similar to an IAM user, but is not associated with a speciﬁc person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and deﬁne permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are deﬁned by the role. For information about roles for federation, see Create a role for a third-party identity provider (federation) in the IAM User Guide. If you use IAM Identity Center, you conﬁgure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can
storagegateway-tgw-ug-090	storagegateway-tgw-ug.pdf	90	the identity is associated with the role and is granted the permissions that are deﬁned by the role. For information about roles for federation, see Create a role for a third-party identity provider (federation) in the IAM User Guide. If you use IAM Identity Center, you conﬁgure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on diﬀerent permissions for a speciﬁc task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a diﬀerent account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource Authenticating with identities API Version 2013-06-30 227 AWS Storage Gateway Tape Gateway User Guide (instead of using a role as a proxy). To learn the diﬀerence between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or store objects in Amazon S3. A service might do this using the calling principal's permissions, using a service role, or using a service-linked role. • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a diﬀerent service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance proﬁle that is attached to the instance. An instance proﬁle contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, deﬁnes their Managing access using policies API Version 2013-06-30 228 AWS Storage Gateway Tape Gateway User Guide permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies deﬁne permissions for an action regardless
storagegateway-tgw-ug-091	storagegateway-tgw-ug.pdf	91	more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies deﬁne permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Identity-based policies Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Deﬁne custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed policies include AWS managed policies and customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Resource-based policies Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a speciﬁc resource. For the resource where the policy is attached, the policy deﬁnes what actions a speciﬁed principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. Managing access using policies API Version 2013-06-30 229 AWS Storage Gateway Tape Gateway User Guide Resource-based policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. Access control lists (ACLs) Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Other policy types AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions boundaries. Resource-based policies that specify the user or role in the Principal ﬁeld are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) to any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the eﬀective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Managing access using policies API Version 2013-06-30 230 AWS Storage Gateway Tape Gateway User
storagegateway-tgw-ug-092	storagegateway-tgw-ug.pdf	92	about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the eﬀective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Managing access using policies API Version 2013-06-30 230 AWS Storage Gateway Tape Gateway User Guide Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Multiple policy types When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. How AWS Storage Gateway works with IAM Before you use IAM to manage access to AWS SGW, learn what IAM features are available to use with AWS SGW. IAM features you can use with AWS Storage Gateway IAM feature AWS SGW support Identity-based policies Resource-based policies Policy actions Policy resources Policy condition keys (service-speciﬁc) ACLs ABAC (tags in policies) Temporary credentials Yes No Yes Yes Yes No Partial Yes How AWS Storage Gateway works with IAM API Version 2013-06-30 231 AWS Storage Gateway IAM feature Forward access sessions (FAS) Service roles Service-linked roles AWS SGW support Yes Yes Yes Tape Gateway User Guide To get a high-level view of how AWS SGW and other AWS services work with most IAM features, see AWS services that work with IAM in the IAM User Guide. Identity-based policies for AWS SGW Supports identity-based policies: Yes Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Deﬁne custom IAM permissions with customer managed policies in the IAM User Guide. With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. You can't specify the principal in an identity-based policy because it applies to the user or role to which it is attached. To learn about all of the elements that you can use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide. Identity-based policy examples for AWS SGW To view examples of AWS SGW identity-based policies, see Identity-based policy examples for Storage Gateway. Resource-based policies within AWS SGW Supports resource-based policies: No Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a speciﬁc resource. For the resource where the policy is attached, the policy deﬁnes what actions a speciﬁed How AWS Storage Gateway works with IAM API Version 2013-06-30 232 AWS Storage Gateway Tape Gateway User Guide principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. To enable cross-account access, you can specify an entire account or IAM entities in another account as the principal in a resource-based policy. Adding a cross-account principal to a resource- based policy is only half of establishing the trust relationship. When the principal and the resource are in diﬀerent AWS accounts, an IAM administrator in the trusted account must also grant the principal entity (user or role) permission to access the resource. They grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information, see Cross account resource access in IAM in the IAM User Guide. Policy actions for AWS SGW Supports policy actions: Yes Administrators can use AWS JSON policies to specify who has access to what.
storagegateway-tgw-ug-093	storagegateway-tgw-ug.pdf	93	When the principal and the resource are in diﬀerent AWS accounts, an IAM administrator in the trusted account must also grant the principal entity (user or role) permission to access the resource. They grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information, see Cross account resource access in IAM in the IAM User Guide. Policy actions for AWS SGW Supports policy actions: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. To see a list of AWS SGW actions, see Actions Deﬁned by AWS Storage Gateway in the Service Authorization Reference. Policy actions in AWS SGW use the following preﬁx before the action: sgw To specify multiple actions in a single statement, separate them with commas. "Action": [ "sgw:action1", How AWS Storage Gateway works with IAM API Version 2013-06-30 233 AWS Storage Gateway "sgw:action2" ] Tape Gateway User Guide To view examples of AWS SGW identity-based policies, see Identity-based policy examples for Storage Gateway. Policy resources for AWS SGW Supports policy resources: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Resource JSON policy element speciﬁes the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a speciﬁc resource type, known as resource-level permissions. For actions that don't support resource-level permissions, such as listing operations, use a wildcard () to indicate that the statement applies to all resources. "Resource": "" To see a list of AWS SGW resource types and their ARNs, see Resources Deﬁned by AWS Storage Gateway in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions Deﬁned by AWS Storage Gateway . To view examples of AWS SGW identity-based policies, see Identity-based policy examples for Storage Gateway. Policy condition keys for AWS SGW Supports service-speciﬁc policy condition keys: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. How AWS Storage Gateway works with IAM API Version 2013-06-30 234 AWS Storage Gateway Tape Gateway User Guide The Condition element (or Condition block) lets you specify conditions in which a statement is in eﬀect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide. AWS supports global condition keys and service-speciﬁc condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. To see a list of AWS SGW condition keys, see Condition Keys for AWS Storage Gateway in the Service Authorization Reference. To learn with which actions and resources you can use a condition key, see Actions Deﬁned by AWS Storage Gateway . To view examples of AWS SGW identity-based policies, see Identity-based policy examples for Storage Gateway. ACLs in AWS SGW Supports ACLs: No Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. ABAC with AWS SGW Supports ABAC (tags in policies):
storagegateway-tgw-ug-094	storagegateway-tgw-ug.pdf	94	condition keys, see Condition Keys for AWS Storage Gateway in the Service Authorization Reference. To learn with which actions and resources you can use a condition key, see Actions Deﬁned by AWS Storage Gateway . To view examples of AWS SGW identity-based policies, see Identity-based policy examples for Storage Gateway. ACLs in AWS SGW Supports ACLs: No Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. ABAC with AWS SGW Supports ABAC (tags in policies): Partial Attribute-based access control (ABAC) is an authorization strategy that deﬁnes permissions based on attributes. In AWS, these attributes are called tags. You can attach tags to IAM entities (users or roles) and to many AWS resources. Tagging entities and resources is the ﬁrst step of ABAC. Then How AWS Storage Gateway works with IAM API Version 2013-06-30 235 AWS Storage Gateway Tape Gateway User Guide you design ABAC policies to allow operations when the principal's tag matches the tag on the resource that they are trying to access. ABAC is helpful in environments that are growing rapidly and helps with situations where policy management becomes cumbersome. To control access based on tags, you provide tag information in the condition element of a policy using the aws:ResourceTag/key-name, aws:RequestTag/key-name, or aws:TagKeys condition keys. If a service supports all three condition keys for every resource type, then the value is Yes for the service. If a service supports all three condition keys for only some resource types, then the value is Partial. For more information about ABAC, see Deﬁne permissions with ABAC authorization in the IAM User Guide. To view a tutorial with steps for setting up ABAC, see Use attribute-based access control (ABAC) in the IAM User Guide. Using temporary credentials with AWS SGW Supports temporary credentials: Yes Some AWS services don't work when you sign in using temporary credentials. For additional information, including which AWS services work with temporary credentials, see AWS services that work with IAM in the IAM User Guide. You are using temporary credentials if you sign in to the AWS Management Console using any method except a user name and password. For example, when you access AWS using your company's single sign-on (SSO) link, that process automatically creates temporary credentials. You also automatically create temporary credentials when you sign in to the console as a user and then switch roles. For more information about switching roles, see Switch from a user to an IAM role (console) in the IAM User Guide. You can manually create temporary credentials using the AWS CLI or AWS API. You can then use those temporary credentials to access AWS. AWS recommends that you dynamically generate temporary credentials instead of using long-term access keys. For more information, see Temporary security credentials in IAM. Forward access sessions for AWS SGW Supports forward access sessions (FAS): Yes How AWS Storage Gateway works with IAM API Version 2013-06-30 236 AWS Storage Gateway Tape Gateway User Guide When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a diﬀerent service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. Service roles for AWS SGW Supports service roles: Yes A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. Warning Changing the permissions for a service role might break AWS SGW functionality. Edit service roles only when AWS SGW provides guidance to do so. Service-linked roles for AWS SGW Supports service-linked roles: Yes A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. For details about creating or managing service-linked roles, see AWS services that work with IAM. Find a service in the table that includes a Yes in the Service-linked role column. Choose the Yes link to view the
storagegateway-tgw-ug-095	storagegateway-tgw-ug.pdf	95	roles for AWS SGW Supports service-linked roles: Yes A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. For details about creating or managing service-linked roles, see AWS services that work with IAM. Find a service in the table that includes a Yes in the Service-linked role column. Choose the Yes link to view the service-linked role documentation for that service. Identity-based policy examples for Storage Gateway By default, users and roles don't have permission to create or modify AWS SGW resources. They also can't perform tasks by using the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS API. To grant users permission to perform actions on the resources that they Identity-based policy examples API Version 2013-06-30 237 AWS Storage Gateway Tape Gateway User Guide need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. To learn how to create an IAM identity-based policy by using these example JSON policy documents, see Create IAM policies (console) in the IAM User Guide. For details about actions and resource types deﬁned by AWS SGW, including the format of the ARNs for each of the resource types, see Actions, Resources, and Condition Keys for AWS Storage Gateway in the Service Authorization Reference. Topics • Policy best practices • Using the AWS SGW console • Allow users to view their own permissions Policy best practices Identity-based policies determine whether someone can create, access, or delete AWS SGW resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by deﬁning AWS customer managed policies that are speciﬁc to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by deﬁning the actions that can be taken on speciﬁc resources under speciﬁc conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a speciﬁc AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. Identity-based policy examples API Version 2013-06-30 238 AWS Storage Gateway Tape Gateway User Guide • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API operations are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Using the AWS SGW console To access the AWS Storage Gateway console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the AWS SGW resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities (users or roles) with that policy. You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or
storagegateway-tgw-ug-096	storagegateway-tgw-ug.pdf	96	IAM, see Security best practices in IAM in the IAM User Guide. Using the AWS SGW console To access the AWS Storage Gateway console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the AWS SGW resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities (users or roles) with that policy. You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that they're trying to perform. To ensure that users and roles can still use the AWS SGW console, also attach the AWS SGW ConsoleAccess or ReadOnly AWS managed policy to the entities. For more information, see Adding permissions to a user in the IAM User Guide. Allow users to view their own permissions This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity. This policy includes permissions to complete this action on the console or programmatically using the AWS CLI or AWS API. { "Version": "2012-10-17", "Statement": [ Identity-based policy examples API Version 2013-06-30 239 Tape Gateway User Guide AWS Storage Gateway { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", "iam:GetUser" ], "Resource": ["arn:aws:iam:::user/${aws:username}"] }, { "Sid": "NavigateInConsole", "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" ], "Resource": "" } ] } Troubleshooting AWS Storage Gateway identity and access Use the following information to help you diagnose and ﬁx common issues that you might encounter when working with AWS SGW and IAM. Topics • I am not authorized to perform an action in AWS SGW • I am not authorized to perform iam:PassRole • I want to allow people outside of my AWS account to access my AWS SGW resources Troubleshooting API Version 2013-06-30 240 AWS Storage Gateway Tape Gateway User Guide I am not authorized to perform an action in AWS SGW If you receive an error that you're not authorized to perform an action, your policies must be updated to allow you to perform the action. The following example error occurs when the mateojackson IAM user tries to use the console to view details about a ﬁctional my-example-widget resource but doesn't have the ﬁctional sgw:GetWidget permissions. User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: sgw:GetWidget on resource: my-example-widget In this case, the policy for the mateojackson user must be updated to allow access to the my- example-widget resource by using the sgw:GetWidget action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I am not authorized to perform iam:PassRole If you receive an error that you're not authorized to perform the iam:PassRole action, your policies must be updated to allow you to pass a role to AWS SGW. Some AWS services allow you to pass an existing role to that service instead of creating a new service role or service-linked role. To do this, you must have permissions to pass the role to the service. The following example error occurs when an IAM user named marymajor tries to use the console to perform an action in AWS SGW. However, the action requires the service to have permissions that are granted by a service role. Mary does not have permissions to pass the role to the service. User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole In this case, Mary's policies must be updated to allow her to perform the iam:PassRole action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. Troubleshooting API Version 2013-06-30 241 AWS Storage Gateway Tape Gateway User Guide I want to allow people outside of my AWS account to access my AWS SGW resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • To learn whether AWS SGW supports these features, see How AWS Storage Gateway works with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide. • To learn how to provide access to your resources to third-party AWS accounts, see Providing access to
storagegateway-tgw-ug-097	storagegateway-tgw-ug.pdf	97	role. For services that support resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • To learn whether AWS SGW supports these features, see How AWS Storage Gateway works with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide. • To learn how to provide access to your resources to third-party AWS accounts, see Providing access to AWS accounts owned by third parties in the IAM User Guide. • To learn how to provide access through identity federation, see Providing access to externally authenticated users (identity federation) in the IAM User Guide. • To learn the diﬀerence between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Compliance validation for AWS Storage Gateway Third-party auditors assess the security and compliance of AWS Storage Gateway as part of multiple AWS compliance programs. These include SOC, PCI, ISO, FedRAMP, HIPAA, MTSC, C5, K- ISMS, ENS High, OSPAR, and HITRUST CSF. For a list of AWS services in scope of speciﬁc compliance programs, see AWS Services in Scope by Compliance Program. For general information, see AWS Compliance Programs. You can download third-party audit reports using AWS Artifact. For more information, see Downloading Reports in AWS Artifact. Your compliance responsibility when using Storage Gateway is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations. AWS provides the following resources to help with compliance: Compliance validation API Version 2013-06-30 242 AWS Storage Gateway Tape Gateway User Guide • Security and Compliance Quick Start Guides – These deployment guides discuss architectural considerations and provide steps for deploying security- and compliance-focused baseline environments on AWS. • Architecting for HIPAA Security and Compliance Whitepaper – This whitepaper describes how companies can use AWS to create HIPAA-compliant applications. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • Evaluating resources with rules in the AWS Conﬁg Developer Guide – The AWS Conﬁg service assesses how well your resource conﬁgurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS that helps you check your compliance with security industry standards and best practices. Resilience in AWS Storage Gateway The AWS global infrastructure is built around AWS Regions and Availability Zones. An AWS Region is a physical location around the world where data centers are clustered. Each group of logical data centers is called an Availability Zone (AZ). Each AWS Region consists of a minimum of three isolated and physically separate AZs within a geographic area. Unlike other cloud providers, who often deﬁne a region as a single data center, the multiple AZ design of every AWS Region oﬀers distinct advantages. Each AZ has independent power, cooling, and physical security and is connected via redundant, ultra-low-latency networks. If your deployment requires a focus on high availability, you can conﬁgure services and resources to in multiple AZs to achieve greater fault-tolerance. AWS Regions meet the highest levels of infrastructure security, compliance, and data protection. All traﬃc between AZs is encrypted. The network performance is suﬃcient to accomplish synchronous replication between AZs. AZs make partitioning services and resources for high availability easy. If your deployment is partitioned across AZs, your resources are better isolated and protected from issues such as power outages, lightning strikes, tornadoes, earthquakes, and more. AZs are physically separated by a meaningful distance from any other AZ, although all are within 100 km (60 miles) of each other. For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure. Resilience API Version 2013-06-30 243 AWS Storage Gateway Tape Gateway User Guide In addition to the AWS global infrastructure, Storage Gateway oﬀers several features to help support your data resiliency and backup needs: • Use VMware vSphere High Availability (VMware HA) to help protect storage workloads against hardware, hypervisor, or network failures. For more information, see Using VMware vSphere High Availability with Storage Gateway. • Archive virtual tapes in S3 Glacier Flexible Retrieval. For more information, see Archiving Virtual Tapes. Infrastructure Security in AWS Storage Gateway As a managed service, AWS Storage Gateway is protected by the AWS global network security procedures that are described in the Amazon Web Services: Overview of Security Processes whitepaper. You use AWS published API calls to access Storage Gateway through the network. Clients must support Transport Layer Security (TLS) 1.2. Clients must also support cipher suites with perfect forward secrecy (PFS) such as Ephemeral Diﬃe-Hellman (DHE) or
storagegateway-tgw-ug-098	storagegateway-tgw-ug.pdf	98	more information, see Using VMware vSphere High Availability with Storage Gateway. • Archive virtual tapes in S3 Glacier Flexible Retrieval. For more information, see Archiving Virtual Tapes. Infrastructure Security in AWS Storage Gateway As a managed service, AWS Storage Gateway is protected by the AWS global network security procedures that are described in the Amazon Web Services: Overview of Security Processes whitepaper. You use AWS published API calls to access Storage Gateway through the network. Clients must support Transport Layer Security (TLS) 1.2. Clients must also support cipher suites with perfect forward secrecy (PFS) such as Ephemeral Diﬃe-Hellman (DHE) or Elliptic Curve Ephemeral Diﬃe- Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal. Or you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Note You should treat the AWS Storage Gateway appliance as a managed virtual machine, and should not attempt to access or modify its installation in any way. Attempting to install scanning software or update any software packages using methods other than the normal gateway update mechanism, may cause the gateway to malfunction and could impact our ability to support or ﬁx the gateway. AWS reviews, analyzes, and remediates CVEs on a regular basis. We incorporate ﬁxes for these issues into Storage Gateway as part of our normal software release cycle. These ﬁxes are typically applied as part of the normal gateway update process during scheduled maintenance windows. For more information about gateway updates, see . Infrastructure Security API Version 2013-06-30 244 AWS Storage Gateway Tape Gateway User Guide AWS Security Best Practices AWS provides a number of security features to consider as you develop and implement your own security policies. These best practices are general guidelines and don’t represent a complete security solution. Because these practices might not be appropriate or suﬃcient for your environment, treat them as helpful considerations rather than prescriptions. For more information, see AWS Security Best Practices. Logging and Monitoring in AWS Storage Gateway Storage Gateway is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in Storage Gateway. CloudTrail captures all API calls for Storage Gateway as events. The calls captured include calls from the Storage Gateway console and code calls to the Storage Gateway API operations. If you create a trail, you can activate continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Storage Gateway. If you don't conﬁgure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail, you can determine the request that was made to Storage Gateway, the IP address from which the request was made, who made the request, when it was made, and additional details. To learn more about CloudTrail, see the AWS CloudTrail User Guide. Storage Gateway Information in CloudTrail CloudTrail is activated on your Amazon Web Services account when you create the account. When activity occurs in Storage Gateway, that activity is recorded in a CloudTrail event along with other AWS service events in Event history. You can view, search, and download recent events in your Amazon Web Services account. For more information, see Viewing Events with CloudTrail Event History. For an ongoing record of events in your Amazon Web Services account, including events for Storage Gateway, create a trail. A trail allows CloudTrail to deliver log ﬁles to an Amazon S3 bucket. By default, when you create a trail in the console, the trail applies to all AWS Regions. The trail logs events from all Regions in the AWS partition and delivers the log ﬁles to the Amazon S3 bucket that you specify. Additionally, you can conﬁgure other AWS services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see the following: • Overview for Creating a Trail AWS Security Best Practices API Version 2013-06-30 245 AWS Storage Gateway Tape Gateway User Guide • CloudTrail Supported Services and Integrations • Conﬁguring Amazon SNS Notiﬁcations for CloudTrail • Receiving CloudTrail Log Files from Multiple Regions and Receiving CloudTrail Log Files from Multiple Accounts All of the Storage Gateway actions are logged and are documented in the Actions topic. For example, calls to the ActivateGateway, ListGateways, and ShutdownGateway actions generate entries in the CloudTrail log ﬁles. Every event or log entry contains information about who generated the request. The identity information helps you determine the following: • Whether the request was made with root or AWS Identity and Access Management (IAM) user credentials. • Whether the request was made with temporary security
storagegateway-tgw-ug-099	storagegateway-tgw-ug.pdf	99	Conﬁguring Amazon SNS Notiﬁcations for CloudTrail • Receiving CloudTrail Log Files from Multiple Regions and Receiving CloudTrail Log Files from Multiple Accounts All of the Storage Gateway actions are logged and are documented in the Actions topic. For example, calls to the ActivateGateway, ListGateways, and ShutdownGateway actions generate entries in the CloudTrail log ﬁles. Every event or log entry contains information about who generated the request. The identity information helps you determine the following: • Whether the request was made with root or AWS Identity and Access Management (IAM) user credentials. • Whether the request was made with temporary security credentials for a role or federated user. • Whether the request was made by another AWS service. For more information, see the CloudTrail userIdentity Element. Understanding Storage Gateway Log File Entries A trail is a conﬁguration that allows delivery of events as log ﬁles to an Amazon S3 bucket that you specify. CloudTrail log ﬁles contain one or more log entries. An event represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on. CloudTrail log ﬁles aren't an ordered stack trace of the public API calls, so they don't appear in any speciﬁc order. The following example shows a CloudTrail log entry that demonstrates the action. { "Records": [{ "eventVersion": "1.02", "userIdentity": { "type": "IAMUser", "principalId": "AIDAII5AUEPBH2M7JTNVC", "arn": "arn:aws:iam::111122223333:user/StorageGateway-team/JohnDoe", "accountId": "111122223333", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "userName": "JohnDoe" Understanding Storage Gateway Log File Entries API Version 2013-06-30 246 AWS Storage Gateway }, Tape Gateway User Guide "eventTime": "2014-12-04T16:19:00Z", "eventSource": "storagegateway.amazonaws.com", "eventName": "ActivateGateway", "awsRegion": "us-east-2", "sourceIPAddress": "192.0.2.0", "userAgent": "aws-cli/1.6.2 Python/2.7.6 Linux/2.6.18-164.el5", "requestParameters": { "gatewayTimezone": "GMT-5:00", "gatewayName": "cloudtrailgatewayvtl", "gatewayRegion": "us-east-2", "activationKey": "EHFBX-1NDD0-P0IVU-PI259- DHK88", "gatewayType": "VTL" }, "responseElements": { "gatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/cloudtrailgatewayvtl" }, "requestID": "54BTFGNQI71987UJD2IHTCT8NF1Q8GLLE1QEU3KPGG6F0KSTAUU0", "eventID": "635f2ea2-7e42-45f0- bed1-8b17d7b74265", "eventType": "AwsApiCall", "apiVersion": "20130630", "recipientAccountId": "444455556666" }] } The following example shows a CloudTrail log entry that demonstrates the ListGateways action. { "Records": [{ "eventVersion": "1.02", "userIdentity": { "type": "IAMUser", "principalId": "AIDAII5AUEPBH2M7JTNVC", "arn": "arn:aws:iam::111122223333:user/StorageGateway- team/JohnDoe", "accountId:" 111122223333", " accessKeyId ":" AKIAIOSFODNN7EXAMPLE", " userName ":" JohnDoe " }, Understanding Storage Gateway Log File Entries API Version 2013-06-30 247 AWS Storage Gateway Tape Gateway User Guide " eventTime ":" 2014 - 12 - 03T19: 41: 53Z ", " eventSource ":" storagegateway.amazonaws.com ", " eventName ":" ListGateways ", " awsRegion ":" us-east-2 ", " sourceIPAddress ":" 192.0.2.0 ", " userAgent ":" aws - cli / 1.6.2 Python / 2.7.6 Linux / 2.6.18 - 164.el5 ", " requestParameters ":null, " responseElements ":null, "requestID ":" 6U2N42CU37KAO8BG6V1I23FRSJ1Q8GLLE1QEU3KPGG6F0KSTAUU0 ", " eventID ":" f76e5919 - 9362 - 48ff - a7c4 - d203a189ec8d ", " eventType ":" AwsApiCall ", " apiVersion ":" 20130630 ", " recipientAccountId ":" 444455556666" }] } Understanding Storage Gateway Log File Entries API Version 2013-06-30 248 AWS Storage Gateway Tape Gateway User Guide Troubleshooting your gateway Following, you can ﬁnd information about best practices and troubleshooting issues related to gateways, host platforms, virtual tapes, high availability, data recovery, and security. The on-premises gateway troubleshooting information covers gateways deployed on supported virtualization platforms. The troubleshooting information for high availability issues covers gateways running on VMware vSphere High Availability (HA) platform. Topics • Troubleshooting: gateway oﬄine issues - Learn how to diagnose problems that can cause your gateway to appear oﬄine in the Storage Gateway console. • Troubleshooting: internal error during gateway activation - Learn what to do if you receive an internal error message when attempting to activate your Storage Gateway. • Troubleshooting on-premises gateway issues - Learn about typical issues that you might encounter working with your on-premises gateways, and how to allow Support to connect to your gateway to assist with troubleshooting. • Troubleshooting Microsoft Hyper-V setup - Learn about typical issues that you might encounter when deploying Storage Gateway on the Microsoft Hyper-V platform. • Troubleshooting Amazon EC2 gateway issues - Find information about typical issues that you might encounter when working with gateways deployed on Amazon EC2. • Troubleshooting hardware appliance issues - Learn how to resolve issues that you might encounter with the Storage Gateway Hardware Appliance. • Troubleshooting virtual tape issues - Learn about actions you can take if you experience unexpected issues with your virtual tapes. • Troubleshooting high availability issues - Learn what to do if you experience issues with gateways that are deployed in a VMware HA environment. Troubleshooting: gateway oﬄine issues Use the following troubleshooting information to determine what to do if the AWS Storage Gateway console shows that your gateway is oﬄine. Your gateway might be showing as oﬄine for one or more of the following reasons: • The gateway can't reach the Storage Gateway service endpoints. Troubleshooting: gateway oﬄine issues API Version 2013-06-30 249 AWS Storage Gateway Tape Gateway User Guide • The gateway shut down unexpectedly. • A cache disk associated with the gateway has been
storagegateway-tgw-ug-100	storagegateway-tgw-ug.pdf	100	Learn what to do if you experience issues with gateways that are deployed in a VMware HA environment. Troubleshooting: gateway oﬄine issues Use the following troubleshooting information to determine what to do if the AWS Storage Gateway console shows that your gateway is oﬄine. Your gateway might be showing as oﬄine for one or more of the following reasons: • The gateway can't reach the Storage Gateway service endpoints. Troubleshooting: gateway oﬄine issues API Version 2013-06-30 249 AWS Storage Gateway Tape Gateway User Guide • The gateway shut down unexpectedly. • A cache disk associated with the gateway has been disconnected or modiﬁed, or has failed. To bring your gateway back online, identify and resolve the issue that caused your gateway to go oﬄine. Check the associated ﬁrewall or proxy If you conﬁgured your gateway to use a proxy, or you placed your gateway behind a ﬁrewall, then review the access rules of the proxy or ﬁrewall. The proxy or ﬁrewall must allow traﬃc to and from the network ports and service endpoints required by Storage Gateway. For more information, see Network and ﬁrewall requirements. Check for an ongoing SSL or deep-packet inspection of your gateway's traﬃc If an SSL or deep-packet inspection is currently being performed on the network traﬃc between your gateway and AWS, then your gateway might not be able to communicate with the required service endpoints. To bring your gateway back online, you must disable the inspection. Check for a power outage or hardware failure on the hypervisor host A power outage or hardware failure on the hypervisor host of your gateway can cause your gateway to shut down unexpectedly and become unreachable. After you restore the power and network connectivity, your gateway will become reachable again. After your gateway is back online, be sure to take steps to recover your data. For more information, see Best practices for recovering your data. Check for issues with an associated cache disk Your gateway can go oﬄine if at least one of the cache disks associated with your gateway was removed, changed, or resized, or if it is corrupted. If a working cache disk was removed from the hypervisor host: 1. Shut down the gateway. 2. Re-add the disk. Check the associated ﬁrewall or proxy API Version 2013-06-30 250 Tape Gateway User Guide AWS Storage Gateway Note Make sure you add the disk to the same disk node. 3. Restart the gateway. If a cache disk is corrupted, was replaced, or was resized: 1. Shut down the gateway. 2. Reset the cache disk. 3. Reconﬁgure the disk for cache storage. 4. Restart the gateway. For more information on troubleshooting a corrupted cache disk for a tape gateway, see You need to recover a virtual tape from a malfunctioning cache disk. Troubleshooting: internal error during gateway activation Storage Gateway activation requests traverse two network paths. Incoming activation requests sent by a client connect to the gateway's virtual machine (VM) or Amazon Elastic Compute Cloud (Amazon EC2) instance over port 80. If the gateway successfully receives the activation request, then the gateway communicates with the Storage Gateway endpoints to receive an activation key. If the gateway can't reach the Storage Gateway endpoints, then the gateway responds to the client with an internal error message. Use the following troubleshooting information to determine what to do if you receive an internal error message when attempting to activate your AWS Storage Gateway. Note • Make sure you deploy new gateways using the latest virtual machine image ﬁle or Amazon Machine Image (AMI) version. You will receive an internal error if you attempt to activate a gateway that uses an outdated AMI. Troubleshooting: gateway activation issues API Version 2013-06-30 251 AWS Storage Gateway Tape Gateway User Guide • Make sure that you select the correct gateway type that you intend to deploy before you download the AMI. The .ova ﬁles and AMIs for each gateway type are diﬀerent, and they are not interchangeable. Resolve errors when activating your gateway using a public endpoint To resolve activation errors when activating your gateway using a public endpoint, perform the following checks and conﬁgurations. Check the required ports For gateways deployed on-premises, check that the ports are open on your local ﬁrewall. For gateways deployed on an Amazon EC2 instance, check that the ports are open on the instance's security group. To conﬁrm that the ports are open, run a telnet command on the public endpoint from a server. This server must be in the same subnet as the gateway. For example, the following telnet commands test the connection to port 443: telnet d4kdq0yaxexbo.cloudfront.net 443 telnet storagegateway.region.amazonaws.com 443 telnet dp-1.storagegateway.region.amazonaws.com 443 telnet proxy-app.storagegateway.region.amazonaws.com 443 telnet client-cp.storagegateway.region.amazonaws.com 443 telnet anon-cp.storagegateway.region.amazonaws.com 443 To conﬁrm that the gateway itself can reach the endpoint, access the gateway's local VM console (for
storagegateway-tgw-ug-101	storagegateway-tgw-ug.pdf	101	open on your local ﬁrewall. For gateways deployed on an Amazon EC2 instance, check that the ports are open on the instance's security group. To conﬁrm that the ports are open, run a telnet command on the public endpoint from a server. This server must be in the same subnet as the gateway. For example, the following telnet commands test the connection to port 443: telnet d4kdq0yaxexbo.cloudfront.net 443 telnet storagegateway.region.amazonaws.com 443 telnet dp-1.storagegateway.region.amazonaws.com 443 telnet proxy-app.storagegateway.region.amazonaws.com 443 telnet client-cp.storagegateway.region.amazonaws.com 443 telnet anon-cp.storagegateway.region.amazonaws.com 443 To conﬁrm that the gateway itself can reach the endpoint, access the gateway's local VM console (for gateways deployed on-premises). Or, you can SSH to the gateway's instance (for gateways deployed on Amazon EC2). Then, run a network connectivity test. Conﬁrm that the test returns [PASSED]. For more information, see Testing Your Gateway Connection to the Internet. Note The default login user name for the gateway console is admin, and the default password is password. Resolve errors when activating your gateway using a public endpoint API Version 2013-06-30 252 AWS Storage Gateway Tape Gateway User Guide Make sure ﬁrewall security does not modify packets sent from the gateway to the public endpoints SSL inspections, deep packet inspections, or other forms of ﬁrewall security can interfere with packets sent from the gateway. The SSL handshake fails if the SSL certiﬁcate is modiﬁed from what the activation endpoint expects. To conﬁrm that there's no SSL inspection in progress, run an OpenSSL command on the main activation endpoint ( anon- cp.storagegateway.region.amazonaws.com) on port 443. You must run this command from a machine that's in the same subnet as the gateway: $ openssl s_client -connect anon-cp.storagegateway.region.amazonaws.com:443 - servername anon-cp.storagegateway.region.amazonaws.com Note Replace region with your AWS Region. If there's no SSL inspection in progress, then the command returns a response similar to the following: $ openssl s_client -connect anon-cp.storagegateway.us-east-2.amazonaws.com:443 - servername anon-cp.storagegateway.us-east-2.amazonaws.com CONNECTED(00000003) depth=2 C = US, O = Amazon, CN = Amazon Root CA 1 verify return:1 depth=1 C = US, O = Amazon, OU = Server CA 1B, CN = Amazon verify return:1 depth=0 CN = anon-cp.storagegateway.us-east-2.amazonaws.com verify return:1 --- Certificate chain 0 s:/CN=anon-cp.storagegateway.us-east-2.amazonaws.com i:/C=US/O=Amazon/OU=Server CA 1B/CN=Amazon 1 s:/C=US/O=Amazon/OU=Server CA 1B/CN=Amazon i:/C=US/O=Amazon/CN=Amazon Root CA 1 2 s:/C=US/O=Amazon/CN=Amazon Root CA 1 i:/C=US/ST=Arizona/L=Scottsdale/O=Starfield Technologies, Inc./CN=Starfield Services Root Certificate Authority - G2 3 s:/C=US/ST=Arizona/L=Scottsdale/O=Starfield Technologies, Inc./CN=Starfield Services Root Certificate Authority - G2 Resolve errors when activating your gateway using a public endpoint API Version 2013-06-30 253 AWS Storage Gateway Tape Gateway User Guide i:/C=US/O=Starfield Technologies, Inc./OU=Starfield Class 2 Certification Authority --- If there is an ongoing SSL inspection, then the response shows an altered certiﬁcate chain, similar to the following: $ openssl s_client -connect anon-cp.storagegateway.ap-southeast-1.amazonaws.com:443 - servername anon-cp.storagegateway.ap-southeast-1.amazonaws.com CONNECTED(00000003) depth=0 DC = com, DC = amazonaws, OU = AWS, CN = anon-cp.storagegateway.ap- southeast-1.amazonaws.com verify error:num=20:unable to get local issuer certificate verify return:1 depth=0 DC = com, DC = amazonaws, OU = AWS, CN = anon-cp.storagegateway.ap- southeast-1.amazonaws.com verify error:num=21:unable to verify the first certificate verify return:1 --- Certificate chain 0 s:/DC=com/DC=amazonaws/OU=AWS/CN=anon-cp.storagegateway.ap-southeast-1.amazonaws.com i:/C=IN/O=Company/CN=Admin/ST=KA/L=New town/OU=SGW/emailAddress=admin@company.com --- The activation endpoint accepts SSL handshakes only if it recognizes the SSL certiﬁcate. This means that the gateway's outbound traﬃc to the endpoints must be exempt from inspections performed by ﬁrewalls in your network. These inspections might be an SSL inspection or a deep packet inspection. Check gateway time synchronization Excessive time skews can cause SSL handshake errors. For on-premises gateways, you can use the gateway's local VM console to check your gateway's time synchronization. The time skew should be no larger than 60 seconds. For more information, see Synchronizing Your Gateway VM Time. The System Time Management option isn't available on gateways that are hosted on Amazon EC2 instances. To make sure Amazon EC2 gateways can properly synchronize time, conﬁrm that the Amazon EC2 instance can connect to the following NTP server pool list over ports UDP and TCP 123: • 0.amazon.pool.ntp.org • 1.amazon.pool.ntp.org Resolve errors when activating your gateway using a public endpoint API Version 2013-06-30 254 AWS Storage Gateway • 2.amazon.pool.ntp.org • 3.amazon.pool.ntp.org Tape Gateway User Guide Resolve errors when activating your gateway using an Amazon VPC endpoint To resolve activation errors when activating your gateway using an Amazon Virtual Private Cloud (Amazon VPC) endpoint, perform the following checks and conﬁgurations. Check the required ports Make sure the required ports within your local ﬁrewall (for gateways deployed on-premises) or security group (for gateways deployed in Amazon EC2) are open. The ports required for connecting a gateway to a Storage Gateway VPC endpoint diﬀer from those required when connecting a gateway to public endpoints. The following ports are required for connecting to a Storage Gateway VPC endpoint: • TCP 443 • TCP 1026 • TCP 1027 • TCP 1028 • TCP 1031 • TCP 2222 For more information, see Creating a VPC endpoint for Storage Gateway. Additionally, check
storagegateway-tgw-ug-102	storagegateway-tgw-ug.pdf	102	following checks and conﬁgurations. Check the required ports Make sure the required ports within your local ﬁrewall (for gateways deployed on-premises) or security group (for gateways deployed in Amazon EC2) are open. The ports required for connecting a gateway to a Storage Gateway VPC endpoint diﬀer from those required when connecting a gateway to public endpoints. The following ports are required for connecting to a Storage Gateway VPC endpoint: • TCP 443 • TCP 1026 • TCP 1027 • TCP 1028 • TCP 1031 • TCP 2222 For more information, see Creating a VPC endpoint for Storage Gateway. Additionally, check the security group that's attached to your Storage Gateway VPC endpoint. The default security group attached to the endpoint might not allow the required ports. Create a new security group that allows traﬃc from your gateway's IP address range over the required ports. Then, attach that security group to the VPC endpoint. Note Use the Amazon VPC console to verify the security group that's attached to the VPC endpoint. View your Storage Gateway VPC endpoint from the console, and then choose the Security Groups tab. Resolve errors when activating your gateway using an Amazon VPC endpoint API Version 2013-06-30 255 AWS Storage Gateway Tape Gateway User Guide To conﬁrm that the required ports are open, you can run telnet commands on the Storage Gateway VPC Endpoint. You must run these commands from a server that's in the same subnet as the gateway. You can run the tests on the ﬁrst DNS name that doesn't specify an Availability Zone. For example, the following telnet commands test the required port connections using the DNS name vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com: telnet vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com 443 telnet vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com 1026 telnet vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com 1027 telnet vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com 1028 telnet vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com 1031 telnet vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com 2222 Make sure ﬁrewall security does not modify packets sent from the gateway to your Storage Gateway Amazon VPC endpoint SSL inspections, deep packet inspections, or other forms of ﬁrewall security can interfere with packets sent from the gateway. The SSL handshake fails if the SSL certiﬁcate is modiﬁed from what the activation endpoint expects. To conﬁrm that there's no SSL inspection in progress, run an OpenSSL command on your Storage Gateway VPC endpoint. You must run this command from a machine that's in the same subnet as the gateway. Run the command for each required port: $ openssl s_client -connect vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com:443 -servername vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com $ openssl s_client -connect vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com:1026 -servername vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com $ openssl s_client -connect vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com:1027 -servername vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com $ openssl s_client -connect vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com:1028 -servername vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com $ openssl s_client -connect vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com:1031 -servername vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com Resolve errors when activating your gateway using an Amazon VPC endpoint API Version 2013-06-30 256 AWS Storage Gateway Tape Gateway User Guide $ openssl s_client -connect vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com:2222 -servername vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com If there's no SSL inspection in progress, then the command returns a response similar to the following: openssl s_client -connect vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com:1027 -servername vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com CONNECTED(00000005) depth=2 C = US, O = Amazon, CN = Amazon Root CA 1 verify return:1 depth=1 C = US, O = Amazon, OU = Server CA 1B, CN = Amazon verify return:1 depth=0 CN = anon-cp.storagegateway.us-east-1.amazonaws.com verify return:1 --- Certificate chain 0 s:CN = anon-cp.storagegateway.us-east-1.amazonaws.com i:C = US, O = Amazon, OU = Server CA 1B, CN = Amazon 1 s:C = US, O = Amazon, OU = Server CA 1B, CN = Amazon i:C = US, O = Amazon, CN = Amazon Root CA 1 2 s:C = US, O = Amazon, CN = Amazon Root CA 1 i:C = US, ST = Arizona, L = Scottsdale, O = "Starfield Technologies, Inc.", CN = Starfield Services Root Certificate Authority - G2 3 s:C = US, ST = Arizona, L = Scottsdale, O = "Starfield Technologies, Inc.", CN = Starfield Services Root Certificate Authority - G2 i:C = US, O = "Starfield Technologies, Inc.", OU = Starfield Class 2 Certification Authority --- If there is an ongoing SSL inspection, then the response shows an altered certiﬁcate chain, similar to the following: openssl s_client -connect vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us- east-1.vpce.amazonaws.com:1027 -servername vpce-1234567e1c24a1fe9-62qntt8k.storagegateway.us-east-1.vpce.amazonaws.com CONNECTED(00000005) depth=2 C = US, O = Amazon, CN = Amazon Root CA 1 verify return:1 Resolve errors when activating your gateway using an Amazon VPC endpoint API Version 2013-06-30 257 AWS Storage Gateway Tape Gateway User Guide depth=1 C = US, O = Amazon, OU = Server CA 1B, CN = Amazon verify return:1 depth=0 DC = com, DC = amazonaws, OU = AWS, CN = anon-cp.storagegateway.us- east-1.amazonaws.com verify error:num=21:unable to verify the first certificate verify return:1 --- Certificate chain 0 s:/DC=com/DC=amazonaws/OU=AWS/CN=anon-cp.storagegateway.us-east-1.amazonaws.com i:/C=IN/O=Company/CN=Admin/ST=KA/L=New town/OU=SGW/emailAddress=admin@company.com --- The activation endpoint accepts SSL handshakes only if it recognizes the SSL certiﬁcate. This means that the gateway's outbound traﬃc to your VPC endpoint over required ports is exempt from inspections performed by your network ﬁrewalls. These inspections might be SSL inspections or
storagegateway-tgw-ug-103	storagegateway-tgw-ug.pdf	103	2013-06-30 257 AWS Storage Gateway Tape Gateway User Guide depth=1 C = US, O = Amazon, OU = Server CA 1B, CN = Amazon verify return:1 depth=0 DC = com, DC = amazonaws, OU = AWS, CN = anon-cp.storagegateway.us- east-1.amazonaws.com verify error:num=21:unable to verify the first certificate verify return:1 --- Certificate chain 0 s:/DC=com/DC=amazonaws/OU=AWS/CN=anon-cp.storagegateway.us-east-1.amazonaws.com i:/C=IN/O=Company/CN=Admin/ST=KA/L=New town/OU=SGW/emailAddress=admin@company.com --- The activation endpoint accepts SSL handshakes only if it recognizes the SSL certiﬁcate. This means that the gateway's outbound traﬃc to your VPC endpoint over required ports is exempt from inspections performed by your network ﬁrewalls. These inspections might be SSL inspections or deep packet inspections. Check gateway time synchronization Excessive time skews can cause SSL handshake errors. For on-premises gateways, you can use the gateway's local VM console to check your gateway's time synchronization. The time skew should be no larger than 60 seconds. For more information, see Synchronizing Your Gateway VM Time. The System Time Management option isn't available on gateways that are hosted on Amazon EC2 instances. To make sure Amazon EC2 gateways can properly synchronize time, conﬁrm that the Amazon EC2 instance can connect to the following NTP server pool list over ports UDP and TCP 123: • 0.amazon.pool.ntp.org • 1.amazon.pool.ntp.org • 2.amazon.pool.ntp.org • 3.amazon.pool.ntp.org Check for an HTTP proxy and conﬁrm associated security group settings Before activation, check if you have an HTTP proxy on Amazon EC2 conﬁgured on the on-premises gateway VM as a Squid proxy on port 3128. In this case, conﬁrm the following: • The security group attached to the HTTP proxy on Amazon EC2 must have an inbound rule. This inbound rule must allow Squid proxy traﬃc on port 3128 from the gateway VM's IP address. Resolve errors when activating your gateway using an Amazon VPC endpoint API Version 2013-06-30 258 AWS Storage Gateway Tape Gateway User Guide • The security group attached to the Amazon EC2 VPC endpoint must have inbound rules. These inbound rules must allow traﬃc on ports 1026-1028, 1031, 2222, and 443 from the IP address of the HTTP proxy on Amazon EC2. Resolve errors when activating your gateway using a public endpoint and there is a Storage Gateway VPC endpoint in the same VPC To resolve errors when activating your gateway using a public endpoint when there is a Amazon Virtual Private Cloud (Amazon VPC) enpoint in the same VPC, perform the following checks and conﬁgurations. Conﬁrm that the Enable Private DNS Name setting isn't enabled on your Storage Gateway VPC endpoint If Enable Private DNS Name is enabled, you can't activate any gateways from that VPC to the public endpoint. To disable the private DNS name option: 1. Open the Amazon VPC console. 2. In the navigation pane, choose Endpoints. 3. Choose your Storage Gateway VPC endpoint. 4. Choose Actions. 5. Choose Manage Private DNS Names. 6. For Enable Private DNS Name, clear Enable for this Endpoint. 7. Choose Modify Private DNS Names to save the setting. Troubleshooting on-premises gateway issues You can ﬁnd information following about typical issues that you might encounter working with your on-premises gateways, and how to activate Support to help troubleshoot your gateway. The following table lists typical issues that you might encounter working with your on-premises gateways. Resolve errors when activating your gateway using a public endpoint and there is a Storage Gateway VPC endpoint in the same VPC API Version 2013-06-30 259 AWS Storage Gateway Tape Gateway User Guide Issue Action to Take You cannot ﬁnd the IP address of your gateway. Use the hypervisor client to connect to your host to ﬁnd the gateway IP address. • For VMware ESXi, the VM's IP address can be found in the vSphere client on the Summary tab. • For Microsoft Hyper-V, the VM's IP address can be found by logging into the local console. If you are still having trouble ﬁnding the gateway IP address: • Check that the VM is turned on. Only when the VM is turned on does an IP address get assigned to your gateway. • Wait for the VM to ﬁnish startup. If you just turned on your VM, then it might take several minutes for the gateway to ﬁnish its boot sequence. • Allow the appropriate ports for your gateway. • SSL cert validation/inspection should not be activated. Storage Gateway utilizes mutual TLS authentication which would fail if any 3rd party application tries to intercept/sign either certiﬁca te. • If you use a ﬁrewall or router to ﬁlter or limit network traﬃc, you must conﬁgure your ﬁrewall and router to allow these service endpoints for outbound communication to AWS. For more information about network and ﬁrewall requirements, see Network and ﬁrewall requirements. You're having network or ﬁrewall problems. Your gateway's activatio n fails when you click the Proceed to Activation button in the Storage Gateway Management
storagegateway-tgw-ug-104	storagegateway-tgw-ug.pdf	104	ports for your gateway. • SSL cert validation/inspection should not be activated. Storage Gateway utilizes mutual TLS authentication which would fail if any 3rd party application tries to intercept/sign either certiﬁca te. • If you use a ﬁrewall or router to ﬁlter or limit network traﬃc, you must conﬁgure your ﬁrewall and router to allow these service endpoints for outbound communication to AWS. For more information about network and ﬁrewall requirements, see Network and ﬁrewall requirements. You're having network or ﬁrewall problems. Your gateway's activatio n fails when you click the Proceed to Activation button in the Storage Gateway Management Console. • Check that the gateway VM can be accessed by pinging the VM from your client. • Check that your VM has network connectivity to the internet. Otherwise, you'll need to conﬁgure a SOCKS proxy. For more information on doing so, see Conﬁguring a SOCKS5 proxy for your on-premises gateway. Troubleshooting on-premises gateway issues API Version 2013-06-30 260 AWS Storage Gateway Tape Gateway User Guide Issue Action to Take • Check that the host has the correct time, that the host is conﬁgured to synchronize its time automatically to a Network Time Protocol (NTP) server, and that the gateway VM has the correct time. For information about synchronizing the time of hypervisor hosts and VMs, see Synchronize VM time with Hyper- V or Linux KVM host time. • After performing these steps, you can retry the gateway deployment using the Storage Gateway console and the Setup and Activate Gateway wizard. • SSL cert validation/inspection should not be activated. Storage Gateway utilizes mutual TLS authentication which would fail if any 3rd party application tries to intercept/sign either certiﬁca te. • Check that your VM has at least 7.5 GB of RAM. Gateway allocation fails if there is less than 7.5 GB of RAM. For more information, see Requirements for setting up Tape Gateway. You need to remove a disk allocated as upload buﬀer For instructions about removing a disk allocated as upload buﬀer space, see Removing Disks from Your Gateway. space. For example, you might want to reduce the amount of upload buﬀer space for a gateway, or you might need to replace a disk used as an upload buﬀer that has failed. Troubleshooting on-premises gateway issues API Version 2013-06-30 261 AWS Storage Gateway Tape Gateway User Guide Issue Action to Take You need to improve bandwidth between your You can improve the bandwidth from your gateway to AWS by setting up your internet connection to AWS on a network adapter gateway and AWS. (NIC) separate from that connecting your applications and the gateway VM. Taking this approach is useful if you have a high- bandwidth connection to AWS and you want to avoid bandwidth contention, especially during a snapshot restore. For high-thro ughput workload needs, you can use AWS Direct Connect to establish a dedicated network connection between your on-premis es gateway and AWS. To measure the bandwidth of the connectio n from your gateway to AWS, use the CloudBytesDownload metrics of the gateway. For ed and CloudBytesUploaded more on this subject, see Measuring Performance Between Your Tape Gateway and AWS. Improving your internet connectivity helps to ensure that your upload buﬀer does not ﬁll up. Troubleshooting on-premises gateway issues API Version 2013-06-30 262 AWS Storage Gateway Tape Gateway User Guide Issue Action to Take Throughput to or from your gateway drops to • On the Gateway tab of the Storage Gateway console, verify that the IP addresses for your gateway VM are the same that you zero. see using your hypervisor client software (that is, the VMware vSphere client or Microsoft Hyper-V Manager). If you ﬁnd a mismatch, restart your gateway from the Storage Gateway console, as shown in Shutting Down Your Gateway VM. After the restart, the addresses in the IP Addresses list in the Storage Gateway console's Gateway tab should match the IP addresses for your gateway, which you determine from the hypervisor client. • For VMware ESXi, the VM's IP address can be found in the vSphere client on the Summary tab. • For Microsoft Hyper-V, the VM's IP address can be found by logging into the local console. • Check your gateway's connectivity to AWS as described in Testing your gateway connection to the internet. • Check your gateway's network adapter conﬁguration, and ensure that all the interfaces you intended to be activated for the gateway are activated. To view the network adapter conﬁguration for your gateway, follow the instructions in Conﬁguring Your Gateway Network and select the option for viewing your gateway's network conﬁguration. You can view the throughput to and from your gateway from the Amazon CloudWatch console. For more information about measuring throughput to and from your gateway and AWS, see Measuring Performance Between Your Tape Gateway and AWS. See Troubleshooting
storagegateway-tgw-ug-105	storagegateway-tgw-ug.pdf	105	AWS as described in Testing your gateway connection to the internet. • Check your gateway's network adapter conﬁguration, and ensure that all the interfaces you intended to be activated for the gateway are activated. To view the network adapter conﬁguration for your gateway, follow the instructions in Conﬁguring Your Gateway Network and select the option for viewing your gateway's network conﬁguration. You can view the throughput to and from your gateway from the Amazon CloudWatch console. For more information about measuring throughput to and from your gateway and AWS, see Measuring Performance Between Your Tape Gateway and AWS. See Troubleshooting Microsoft Hyper-V setup, which discusses some of the common issues of deploying a gateway on Microsoft Hyper-V. You are having trouble importing (deploying) Storage Gateway on Microsoft Hyper-V. Troubleshooting on-premises gateway issues API Version 2013-06-30 263 AWS Storage Gateway Tape Gateway User Guide Issue Action to Take You receive a message that says: "The data that You receive this message if your gateway VM was created from a clone or snapshot of another gateway VM. If this isn’t the case, has been written to the contact Support. volume in your gateway isn't securely stored at AWS". Allowing Support to help troubleshoot your gateway hosted on- premises Storage Gateway provides a local console you can use to perform several maintenance tasks, including activating Support to access your gateway to assist you with troubleshooting gateway issues. By default, Support access to your gateway is deactivated. You provide this access through the host's local console. To give Support access to your gateway, you ﬁrst log in to the local console for the host, navigate to the Storage Gateway's console, and then connect to the support server. To allow Support access to your gateway 1. Log in to your host'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. At the prompt, enter the corresponding numeral to select Gateway Console. 3. Enter h to open the list of available commands. 4. Do one of the following: • If your gateway is using a public endpoint, in the AVAILABLE COMMANDS window, enter open-support-channel to connect to customer support for Storage Gateway. Allow TCP port 22 so you can open a support channel to AWS. When you connect to customer support, Storage Gateway assigns you a support number. Make a note of your support number. • If your gateway is using a VPC endpoint, in the AVAILABLE COMMANDS window, enter open-support-channel. If your gateway is not activated, provide the VPC endpoint or IP Activating Support to help troubleshoot your gateway API Version 2013-06-30 264 AWS Storage Gateway Tape Gateway User Guide address to connect to customer support for Storage Gateway. Allow TCP port 22 so you can open a support channel to AWS. When you connect to customer support, Storage Gateway assigns you a support number. Make a note of your support number. Note The channel number is not a Transmission Control Protocol/User Datagram Protocol (TCP/UDP) port number. Instead, the gateway makes a Secure Shell (SSH) (TCP 22) connection to Storage Gateway servers and provides the support channel for the connection. 5. After the support channel is established, provide your support service number to Support so Support can provide troubleshooting assistance. 6. When the support session is completed, enter q to end it. Don't close the session until Amazon Web Services Support notiﬁes you that the support session is complete. 7. 8. Enter exit to log out of the gateway console. Follow the prompts to exit the local console. Troubleshooting Microsoft Hyper-V setup The following table lists typical issues that you might encounter when deploying Storage Gateway on the Microsoft Hyper-V platform. Issue Action to Take You try to import a gateway and receive the following error message: "A server error occurred while attempting to import the virtual machine. Import failed. Unable to ﬁnd virtual machine import ﬁles under location [...]. You This error can occur for the following reasons: • If you are not pointing to the root of the unzipped gateway source ﬁles. The last part of the location you specify in the Import Virtual Machine dialog box should be AWS-Storage- Gateway . For example: C:\prod-gateway\unzippedSourceVM\AWS- Storage-Gateway\ . • If you have already deployed a gateway and you did not select the Copy the virtual machine option and check the Duplicate Troubleshooting Microsoft Hyper-V setup issues API Version 2013-06-30 265 AWS Storage Gateway Tape Gateway User Guide Issue Action to Take can import a virtual machine only if you used Hyper-V to create and all ﬁles option in the Import Virtual Machine dialog box, then the VM was created in the location where you have the unzipped gateway
storagegateway-tgw-ug-106	storagegateway-tgw-ug.pdf	106	location you specify in the Import Virtual Machine dialog box should be AWS-Storage- Gateway . For example: C:\prod-gateway\unzippedSourceVM\AWS- Storage-Gateway\ . • If you have already deployed a gateway and you did not select the Copy the virtual machine option and check the Duplicate Troubleshooting Microsoft Hyper-V setup issues API Version 2013-06-30 265 AWS Storage Gateway Tape Gateway User Guide Issue Action to Take can import a virtual machine only if you used Hyper-V to create and all ﬁles option in the Import Virtual Machine dialog box, then the VM was created in the location where you have the unzipped gateway ﬁles and you cannot import from this export it." location again. To ﬁx this problem, get a fresh copy of the unzipped gateway source ﬁles and copy to a new location. Use the new location as the source of the import. If you plan on creating multiple gateways from one unzipped source ﬁles location, you must select Copy the virtual machine and check the Duplicate all ﬁles box in the Import Virtual Machine dialog box. If you have already deployed a gateway and you try to reuse the default folders that store the virtual hard disk ﬁles and virtual machine conﬁguration ﬁles, then this error will occur. To ﬁx this problem, specify new locations under Server in the panel on the left side of the Hyper-V Settings dialog box. You try to import a gateway and receive the following error message: "A server error occurred while attempting to import the virtual machine. Import failed. Import task failed to copy ﬁle from [...]: The ﬁle exists. (0x80070050)" Troubleshooting Microsoft Hyper-V setup issues API Version 2013-06-30 266 AWS Storage Gateway Tape Gateway User Guide Issue Action to Take When you import the gateway make sure you select Copy the virtual machine and check the Duplicate all ﬁles box in the Import Virtual Machine dialog box to create a new unique ID for the VM. You try to import a gateway and receive the following error message: "A server error occurred while attempting to import the virtual machine. Import failed. Import failed because the virtual machine must have a new identiﬁer. Select a new identiﬁer and try the import again." You try to start a gateway VM and receive the This error is likely caused by a CPU discrepancy between the required CPUs for the gateway and the available CPUs on the host. following error message: Ensure that the VM CPU count is supported by the underlying "An error occurred while hypervisor. attempting to start the For more information about the requirements for Storage selected virtual machine(s Gateway, see Requirements for setting up Tape Gateway. ). The child partition processor setting is incompatible with parent partition. 'AWS-Stor age-Gateway' could not initialize. (Virtual machine ID [...])" Troubleshooting Microsoft Hyper-V setup issues API Version 2013-06-30 267 AWS Storage Gateway Tape Gateway User Guide Issue Action to Take You try to start a gateway VM and receive the This error is likely caused by a RAM discrepancy between the required RAM for the gateway and the available RAM on the host. following error message: "An error occurred while Gateway, see Requirements for setting up Tape Gateway. For more information about the requirements for Storage attempting to start the selected virtual machine(s ). 'AWS-Storage-Gatew ay' could not initializ e. (Virtual machine ID [...]) Failed to create partition: Insuﬃcient system resources exist to complete the requested service. (0x800705AA)" Your snapshots and gateway software updates The gateway VM's clock might be oﬀset from the actual time, known as clock drift. Check and correct the VM's time using are occurring at slightly local gateway console's time synchronization option. For more diﬀerent times than information, see Synchronize VM time with Hyper-V or Linux KVM expected. host time. You need to put the unzipped Microsoft Hyper- V Storage Gateway ﬁles on the host ﬁle system. Access the host as you do a typical Microsoft Windows server. For example, if the hypervisor host is name hyperv-server , then you can use the following UNC path \\hyperv-server\c$ , which assumes that the name hyperv-server can be resolved or is deﬁned in your local hosts ﬁle. You are prompted for credentials when connecting to hypervisor. Add your user credentials as a local administrator for the hypervisor host by using the Sconﬁg.cmd tool. Troubleshooting Microsoft Hyper-V setup issues API Version 2013-06-30 268 AWS Storage Gateway Tape Gateway User Guide Issue Action to Take You may notice poor network performance For information about a workaround, see the Microsoft documentation, see Poor network performance on virtual if you turn on virtual machines on a Windows Server 2012 Hyper-V host if VMQ is machine queue (VMQ) turned on. for a Hyper-V host that's using a Broadcom network adapter. Troubleshooting Amazon EC2 gateway issues In the following sections, you can
storagegateway-tgw-ug-107	storagegateway-tgw-ug.pdf	107	Add your user credentials as a local administrator for the hypervisor host by using the Sconﬁg.cmd tool. Troubleshooting Microsoft Hyper-V setup issues API Version 2013-06-30 268 AWS Storage Gateway Tape Gateway User Guide Issue Action to Take You may notice poor network performance For information about a workaround, see the Microsoft documentation, see Poor network performance on virtual if you turn on virtual machines on a Windows Server 2012 Hyper-V host if VMQ is machine queue (VMQ) turned on. for a Hyper-V host that's using a Broadcom network adapter. Troubleshooting Amazon EC2 gateway issues In the following sections, you can ﬁnd typical issues that you might encounter working with your gateway deployed on Amazon EC2. For more information about the diﬀerence between an on- premises gateway and a gateway deployed in Amazon EC2, see Deploy a customized Amazon EC2 instance for Tape Gateway. Topics • Your gateway activation hasn't occurred after a few moments • You can't ﬁnd your EC2 gateway instance in the instance list • You created an Amazon EBS volume but can't attach it to your EC2 gateway instance • You get a message that you have no disks available when you try to add storage volumes • You want to remove a disk allocated as upload buﬀer space to reduce upload buﬀer space • Throughput to or from your EC2 gateway drops to zero • You want Support to help troubleshoot your EC2 gateway • You want to connect to your gateway instance using the Amazon EC2 serial console Your gateway activation hasn't occurred after a few moments Check the following in the Amazon EC2 console: • Port 80 is activated in the security group that you associated with the instance. For more information about adding a security group rule, see Adding a security group rule in the Amazon EC2 User Guide. Troubleshooting Amazon EC2 gateway issues API Version 2013-06-30 269 AWS Storage Gateway Tape Gateway User Guide • The gateway instance is marked as running. In the Amazon EC2 console, the State value for the instance should be RUNNING. • Make sure that your Amazon EC2 instance type meets the minimum requirements, as described in Storage requirements. After correcting the problem, try activating the gateway again. To do this, open the Storage Gateway console, choose Deploy a new Gateway on Amazon EC2, and re-enter the IP address of the instance. You can't ﬁnd your EC2 gateway instance in the instance list If you didn't give your instance a resource tag and you have many instances running, it can be hard to tell which instance you launched. In this case, you can take the following actions to ﬁnd the gateway instance: • Check the name of the Amazon Machine Image (AMI) on the Description tab of the instance. An instance based on the Storage Gateway AMI should start with the text aws-storage-gateway- ami. • If you have several instances based on the Storage Gateway AMI, check the instance launch time to ﬁnd the correct instance. You created an Amazon EBS volume but can't attach it to your EC2 gateway instance Check that the Amazon EBS volume in question is in the same Availability Zone as the gateway instance. If there is a discrepancy in Availability Zones, create a new Amazon EBS volume in the same Availability Zone as your instance. You get a message that you have no disks available when you try to add storage volumes For a newly activated gateway, no volume storage is deﬁned. Before you can deﬁne volume storage, you must allocate local disks to the gateway to use as an upload buﬀer and cache storage. For a gateway deployed to Amazon EC2, the local disks are Amazon EBS volumes attached to the instance. This error message likely occurs because no Amazon EBS volumes are deﬁned for the instance. Can't ﬁnd the EC2 gateway instance in the instance list API Version 2013-06-30 270 AWS Storage Gateway Tape Gateway User Guide Check block devices deﬁned for the instance that is running the gateway. If there are only two block devices (the default devices that come with the AMI), then you should add storage. For more information on doing so, see Deploy a customized Amazon EC2 instance for Tape Gateway. After attaching two or more Amazon EBS volumes, try creating volume storage on the gateway. You want to remove a disk allocated as upload buﬀer space to reduce upload buﬀer space Follow the steps in Determining the size of upload buﬀer to allocate. Throughput to or from your EC2 gateway drops to zero Verify that the gateway instance is running. If the instance is starting due to a reboot, for example, wait for the instance to restart. Also, verify that the gateway IP has not changed. If the instance was stopped and then restarted,
storagegateway-tgw-ug-108	storagegateway-tgw-ug.pdf	108	Amazon EC2 instance for Tape Gateway. After attaching two or more Amazon EBS volumes, try creating volume storage on the gateway. You want to remove a disk allocated as upload buﬀer space to reduce upload buﬀer space Follow the steps in Determining the size of upload buﬀer to allocate. Throughput to or from your EC2 gateway drops to zero Verify that the gateway instance is running. If the instance is starting due to a reboot, for example, wait for the instance to restart. Also, verify that the gateway IP has not changed. If the instance was stopped and then restarted, the IP address of the instance might have changed. In this case, you need to activate a new gateway. You can view the throughput to and from your gateway from the Amazon CloudWatch console. For more information about measuring throughput to and from your gateway and AWS, see Measuring Performance Between Your Tape Gateway and AWS. You want Support to help troubleshoot your EC2 gateway Storage Gateway provides a local console you can use to perform several maintenance tasks, including activating Support to access your gateway to assist you with troubleshooting gateway issues. By default, Support access to your gateway is deactivated. You provide this access through the Amazon EC2 local console. You log in to the Amazon EC2 local console through a Secure Shell (SSH). To successfully log in through SSH, your instance's security group must have a rule that opens TCP port 22. Note If you add a new rule to an existing security group, the new rule applies to all instances that use that security group. For more information about security groups and how to add a security group rule, see Amazon EC2 security groups in the Amazon EC2 User Guide. How to remove a disk allocated as upload buﬀer space to reduce upload buﬀer space API Version 2013-06-30 271 AWS Storage Gateway Tape Gateway User Guide To let Support connect to your gateway, you ﬁrst log in to the local console for the Amazon EC2 instance, navigate to the Storage Gateway's console, and then provide the access. To activate Support access to a gateway deployed on an Amazon EC2 instance 1. Log in to the local console for your Amazon EC2 instance. For instructions, go to Connect to your instance in the Amazon EC2 User Guide. You can use the following command to log in to the EC2 instance's local console. ssh –i PRIVATE-KEY admin@INSTANCE-PUBLIC-DNS-NAME Note The PRIVATE-KEY is the .pem ﬁle containing the private certiﬁcate of the EC2 key pair that you used to launch the Amazon EC2 instance. For more information, see Retrieving the public key for your key pair in the Amazon EC2 User Guide. The INSTANCE-PUBLIC-DNS-NAME is the public Domain Name System (DNS) name of your Amazon EC2 instance that your gateway is running on. You obtain this public DNS name by selecting the Amazon EC2 instance in the EC2 console and clicking the Description tab. 2. At the prompt, enter 6 - Command Prompt to open the Support Channel console. 3. Enter h to open the AVAILABLE COMMANDS window. 4. Do one of the following: • If your gateway is using a public endpoint, in the AVAILABLE COMMANDS window, enter open-support-channel to connect to customer support for Storage Gateway. Allow TCP port 22 so you can open a support channel to AWS. When you connect to customer support, Storage Gateway assigns you a support number. Make a note of your support number. • If your gateway is using a VPC endpoint, in the AVAILABLE COMMANDS window, enter open-support-channel. If your gateway is not activated, provide the VPC endpoint or IP address to connect to customer support for Storage Gateway. Allow TCP port 22 so you can open a support channel to AWS. When you connect to customer support, Storage Gateway assigns you a support number. Make a note of your support number. Activating Support to help troubleshoot the gateway API Version 2013-06-30 272 AWS Storage Gateway Note Tape Gateway User Guide The channel number is not a Transmission Control Protocol/User Datagram Protocol (TCP/UDP) port number. Instead, the gateway makes a Secure Shell (SSH) (TCP 22) connection to Storage Gateway servers and provides the support channel for the connection. 5. After the support channel is established, provide your support service number to Support so Support can provide troubleshooting assistance. 6. When the support session is completed, enter q to end it. Don't close the session until Support notiﬁes you that the support session is complete. Enter exit to exit the Storage Gateway console. Follow the console menus to log out of the Storage Gateway instance. 7. 8. You want to connect to your gateway instance using the Amazon EC2 serial console You can use the Amazon EC2 serial console to troubleshoot boot,
storagegateway-tgw-ug-109	storagegateway-tgw-ug.pdf	109	provides the support channel for the connection. 5. After the support channel is established, provide your support service number to Support so Support can provide troubleshooting assistance. 6. When the support session is completed, enter q to end it. Don't close the session until Support notiﬁes you that the support session is complete. Enter exit to exit the Storage Gateway console. Follow the console menus to log out of the Storage Gateway instance. 7. 8. You want to connect to your gateway instance using the Amazon EC2 serial console You can use the Amazon EC2 serial console to troubleshoot boot, network conﬁguration, and other issues. For instructions and troubleshooting tips, see Amazon EC2 Serial Console in the Amazon Elastic Compute Cloud User Guide. Troubleshooting hardware appliance issues The following topics discuss issues that you might encounter with the Storage Gateway Hardware Appliance, and suggestions on troubleshooting these. You can't determine the service IP address When attempting to connect to your service, make sure that you are using the service's IP address and not the host IP address. Conﬁgure the service IP address in the service console, and the host IP address in the hardware console. You see the hardware console when you start the hardware appliance. To go to the service console from the hardware console, choose Open Service Console. Connect to your Amazon EC2 gateway using the serial console API Version 2013-06-30 273 AWS Storage Gateway Tape Gateway User Guide How do you perform a factory reset? If you need to perform a factory reset on your appliance, contact the Storage Gateway Hardware Appliance team for support, as described in the Support section following. How do you perform a remote restart? If you need to perform a remote restart of your appliance, you can do so using the Dell iDRAC management interface. For more information, see iDRAC9 Virtual Power Cycle: Remotely power cycle Dell EMC PowerEdge Servers on the Dell Technologies InfoHub website. Where do you obtain Dell iDRAC support? The Dell PowerEdge server comes with the Dell iDRAC management interface. We recommend the following: • If you use the iDRAC management interface, you should change the default password. For more information about the iDRAC credentials, see Dell PowerEdge - What is the default sign-in credentials for iDRAC?. • Make sure that the ﬁrmware is up-to-date to prevent security breaches. • Moving the iDRAC network interface to a normal (em) port can cause performance issues or prevent the normal functioning of the appliance. You can't ﬁnd the hardware appliance serial number You can ﬁnd the serial number for your Storage Gateway Hardware Appliance using the Storage Gateway console. To ﬁnd the hardware appliance serial number: 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. Choose Hardware from the navigation menu on the left side of the page. 3. 4. Select your hardware appliance from the list. Locate the Serial Number ﬁeld on the Details tab for your appliance. How to perform a factory reset API Version 2013-06-30 274 AWS Storage Gateway Tape Gateway User Guide Where to obtain hardware appliance support To contact AWS about technical support for your hardware appliance, see Support. The Support team might ask you to activate the support channel to troubleshoot your gateway issues remotely. You don't need this port to be open for the normal operation of your gateway, but it is required for troubleshooting. You can activate the support channel from the hardware console as shown in the procedure following. To open a support channel for AWS 1. Open the hardware console. 2. Choose Open Support Channel at the bottom of the main page of the hardware console, and then press Enter. The assigned port number should appear within 30 seconds if there are no network connectivity or ﬁrewall issues. For example: Status: Open on port 19599 3. Note the port number and provide it to Support. Troubleshooting virtual tape issues You can ﬁnd information following about actions to take if you experience unexpected issues with your virtual tapes. Topics • Recovering a Virtual Tape From An Unrecoverable Gateway • Troubleshooting Irrecoverable Tapes • High Availability Health Notiﬁcations Recovering a Virtual Tape From An Unrecoverable Gateway Although it is rare, your Tape Gateway might encounter an unrecoverable failure. Such a failure can occur in your hypervisor host, the gateway itself, or the cache disks. If a failure occurs, you can recover your tapes by following the troubleshooting instructions in this section. How to get hardware appliance support API Version 2013-06-30 275 AWS Storage Gateway Topics Tape Gateway User Guide • You Need to Recover a Virtual Tape from a Malfunctioning Tape Gateway • You Need to Recover a Virtual Tape from a Malfunctioning Cache Disk You Need to Recover a Virtual Tape from a Malfunctioning Tape Gateway If your Tape Gateway
storagegateway-tgw-ug-110	storagegateway-tgw-ug.pdf	110	Tape Gateway might encounter an unrecoverable failure. Such a failure can occur in your hypervisor host, the gateway itself, or the cache disks. If a failure occurs, you can recover your tapes by following the troubleshooting instructions in this section. How to get hardware appliance support API Version 2013-06-30 275 AWS Storage Gateway Topics Tape Gateway User Guide • You Need to Recover a Virtual Tape from a Malfunctioning Tape Gateway • You Need to Recover a Virtual Tape from a Malfunctioning Cache Disk You Need to Recover a Virtual Tape from a Malfunctioning Tape Gateway If your Tape Gateway or the hypervisor host encounters an unrecoverable failure, you can recover any data that has already been uploaded to AWS to another Tape Gateway. Note that the data written to a tape might not be completely uploaded until that tape has been successfully archived into VTS. The data on tapes recovered to another gateway in this manner may be incomplete or empty. We recommend performing an inventory on all recovered tapes to ensure they contain the expected content. To recover a tape to another Tape Gateway 1. Identify an existing functioning Tape Gateway to serve as your recovery target gateway. If you don't have a Tape Gateway to recover your tapes to, create a new Tape Gateway. For information about how to create a gateway, see Creating a Gateway. 2. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 3. In the navigation pane, choose Gateways, and then choose the Tape Gateway you want to recover tapes from. 4. Choose the Details tab. A tape recovery message is displayed in the tab. 5. Choose Create recovery tapes to deactivate the gateway. 6. In the dialog box that appears, choose Disable gateway. This process permanently halts normal function of your Tape Gateway and exposes any available recovery points. For instructions, see Deactivating your Tape Gateway. 7. From the tapes that the deactivated gateway displays, choose the virtual tape and the recovery point you want to recover. A virtual tape can have multiple recovery points. 8. 9. To begin recovering any tapes you need to the target Tape Gateway, choose Create recovery tape. In the Create recovery tape dialog box, verify the barcode of the virtual tape you want to recover. 10. For Gateway, choose the Tape Gateway you want to recover the virtual tape to. Recovering a Virtual Tape From An Unrecoverable Gateway API Version 2013-06-30 276 AWS Storage Gateway Tape Gateway User Guide 11. Choose Create recovery tape. 12. Delete the failed Tape Gateway so you don't get charged. For instructions, see Deleting your gateway and removing associated resources. Storage Gateway moves the tape from the failed Tape Gateway to the Tape Gateway you speciﬁed. The Tape Gateway marks the tape status as RECOVERED. You Need to Recover a Virtual Tape from a Malfunctioning Cache Disk If your cache disk encounters an error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. The Storage Gateway console displays a message about the error. In the error message, Storage Gateway prompts you to take one of two actions that can recover your tapes: • Shut Down and Re-Add Disks – Take this approach if the disk has intact data and has been removed. For example, if the error occurred because a disk was removed from your host by accident but the disk and the data is intact, you can re-add the disk. To do this, see the procedure later in this topic. • Reset Cache Disk – Take this approach if the cache disk is corrupted or not accessible. If the disk error causes the cache disk to be inaccessible, unusable, or corrupted, you can reset the disk. If you reset the cache disk, tapes that have clean data (that is, tapes for which data in the cache disk and Amazon S3 are synchronized) will continue to be available for you to use. However, tapes that have data that is not synchronized with Amazon S3 are automatically recovered. The status of these tapes is set to RECOVERED, but the tapes will be read-only. For information about how to remove a disk from your host, see Determining the size of upload buﬀer to allocate. Important If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, no conﬁgured cache disks will be left in the gateway, so you must conﬁgure at least one new cache disk for your gateway to function properly. To reset the cache disk, see the procedure later in this topic. Recovering a Virtual Tape From An Unrecoverable Gateway API Version 2013-06-30 277 AWS
storagegateway-tgw-ug-111	storagegateway-tgw-ug.pdf	111	For information about how to remove a disk from your host, see Determining the size of upload buﬀer to allocate. Important If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, no conﬁgured cache disks will be left in the gateway, so you must conﬁgure at least one new cache disk for your gateway to function properly. To reset the cache disk, see the procedure later in this topic. Recovering a Virtual Tape From An Unrecoverable Gateway API Version 2013-06-30 277 AWS Storage Gateway Tape Gateway User Guide To shut down and re-add a disk 1. Shut down the gateway. For information about how to shut down a gateway, see Shutting Down Your Gateway VM. 2. Add the disk back to your host, and make sure the disk node number of the disk has not changed. For information about how to add a disk, see Determining the size of upload buﬀer to allocate. 3. Restart the gateway. For information about how to restart a gateway, see Shutting Down Your Gateway VM. After the gateway restarts, you can verify the status of the cache disks. The status of a disk can be one of the following: • present – The disk is available to use. • missing – The disk is no longer connected to the gateway. • mismatch – The disk node is occupied by a disk that has incorrect metadata, or the disk content is corrupted. To reset and reconﬁgure a cache disk 1. In the A disk error has occurred error message illustrated preceding, choose Reset Cache Disk. 2. On the Conﬁgure gateway page, conﬁgure the disk for cache storage. For information about how to do so, see Conﬁgure your Tape Gateway. 3. After you have conﬁgured cache storage, shut down and restart the gateway as described in the previous procedure. The gateway should recover after the restart. You can then verify the status of the cache disk. To verify the status of a cache disk 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 your gateway. For Actions, choose Conﬁgure Local Storage to display the Conﬁgure Local Storage dialog box. This dialog box shows all local disks in the gateway. Recovering a Virtual Tape From An Unrecoverable Gateway API Version 2013-06-30 278 AWS Storage Gateway Tape Gateway User Guide The cache disk node status is displayed next to the disk. Note If you don't complete the recovery process, the gateway displays a banner that prompts you to conﬁgure local storage. Troubleshooting Irrecoverable Tapes If your virtual tape fails unexpectedly, Storage Gateway sets the status of the failed virtual tape to IRRECOVERABLE. The action you take depends on the circumstances. You can ﬁnd information following on some issues you might ﬁnd, and how to troubleshoot them. You Need to Recover Data From an IRRECOVERABLE Tape If you have a virtual tape with the status IRRECOVERABLE, and you need to work with it, try one of the following: • Activate a new Tape Gateway if you don't have one activated. For more information, see Creating a Gateway. • Deactivate the Tape Gateway that contains the irrecoverable tape, and recover the tape from a recovery point to the new Tape Gateway. For more information, see You Need to Recover a Virtual Tape from a Malfunctioning Tape Gateway. Note You have to reconﬁgure your iSCSI initiator and backup application to use the new Tape Gateway. For more information, see Connecting your VTL devices. You Don't Need an IRRECOVERABLE Tape That Isn't Archived If you have a virtual tape with the status IRRECOVERABLE, you don't need it, and the tape has never been archived, you should delete the tape. For more information, see Deleting virtual tapes from your Tape Gateway. Troubleshooting Irrecoverable Tapes API Version 2013-06-30 279 AWS Storage Gateway Tape Gateway User Guide A Cache Disk in Your Gateway Encounters a Failure If one or more cache disks in your gateway encounters a failure, the gateway prevents read and write operations to your virtual tapes and volumes. To resume normal functionality, reconﬁgure your gateway as described following: • If the cache disk is inaccessible or unusable, delete the disk from your gateway conﬁguration. • If the cache disk is still accessible and useable, reconnect it to your gateway. Note If you delete a cache disk, tapes or volumes that have clean data (that is, for which data in the cache disk and Amazon S3 are synchronized) will continue to be available when the gateway resumes normal functionality. For example, if your gateway has three cache disks and you delete two, tapes or volumes that are clean will have AVAILABLE status. Other tapes
storagegateway-tgw-ug-112	storagegateway-tgw-ug.pdf	112	your gateway as described following: • If the cache disk is inaccessible or unusable, delete the disk from your gateway conﬁguration. • If the cache disk is still accessible and useable, reconnect it to your gateway. Note If you delete a cache disk, tapes or volumes that have clean data (that is, for which data in the cache disk and Amazon S3 are synchronized) will continue to be available when the gateway resumes normal functionality. For example, if your gateway has three cache disks and you delete two, tapes or volumes that are clean will have AVAILABLE status. Other tapes and volumes will have IRRECOVERABLE status. If you use ephemeral disks as cache disks for your gateway or mount your cache disks on an ephemeral drive, your cache disks will be lost when you shut down the gateway. Shutting down the gateway when your cache disk and Amazon S3 are not synchronized can result in data loss. As a result, we don't recommend using ephemeral drives or disks. High Availability Health Notiﬁcations When running your gateway on the VMware vSphere High Availability (HA) platform, you may receive health notiﬁcations. For more information about health notiﬁcations, see Troubleshooting high availability issues. Troubleshooting high availability issues You can ﬁnd information following about actions to take if you experience availability issues. Topics • Health notiﬁcations • Metrics High Availability Health Notiﬁcations API Version 2013-06-30 280 AWS Storage Gateway Health notiﬁcations Tape Gateway User Guide When you run your gateway on VMware vSphere HA, all gateways produce the following health notiﬁcations to your conﬁgured Amazon CloudWatch log group. These notiﬁcations go into a log stream called AvailabilityMonitor. Topics • Notiﬁcation: Reboot • Notiﬁcation: HardReboot • Notiﬁcation: HealthCheckFailure • Notiﬁcation: AvailabilityMonitorTest Notiﬁcation: Reboot You can get a reboot notiﬁcation when the gateway VM is restarted. You can restart a gateway VM by using the VM Hypervisor Management console or the Storage Gateway console. You can also restart by using the gateway software during the gateway's maintenance cycle. Action to Take If the time of the reboot is within 10 minutes of the gateway's conﬁgured maintenance start time, this is probably a normal occurrence and not a sign of any problem. If the reboot occurred signiﬁcantly outside the maintenance window, check whether the gateway was restarted manually. Notiﬁcation: HardReboot You can get a HardReboot notiﬁcation when the gateway VM is restarted unexpectedly. Such a restart can be due to loss of power, a hardware failure, or another event. For VMware gateways, a reset by vSphere High Availability Application Monitoring can launch this event. Action to Take When your gateway runs in such an environment, check for the presence of the HealthCheckFailure notiﬁcation and consult the VMware events log for the VM. Notiﬁcation: HealthCheckFailure For a gateway on VMware vSphere HA, you can get a HealthCheckFailure notiﬁcation when a health check fails and a VM restart is requested. This event also occurs during a test to Health notiﬁcations API Version 2013-06-30 281 AWS Storage Gateway Tape Gateway User Guide monitor availability, indicated by an AvailabilityMonitorTest notiﬁcation. In this case, the HealthCheckFailure notiﬁcation is expected. Note This notiﬁcation is for VMware gateways only. Action to Take If this event repeatedly occurs without an AvailabilityMonitorTest notiﬁcation, check your VM infrastructure for issues (storage, memory, and so on). If you need additional assistance, contact Support. Notiﬁcation: AvailabilityMonitorTest For a gateway on VMware vSphere HA, you can get an AvailabilityMonitorTest notiﬁcation when you run a test of the Availability and application monitoring system in VMware. Metrics The AvailabilityNotifications metric is available on all gateways. This metric is a count of the number of availability-related health notiﬁcations generated by the gateway. Use the Sum statistic to observe whether the gateway is experiencing any availability-related events. Consult with your conﬁgured CloudWatch log group for details about the events. Metrics API Version 2013-06-30 282 AWS Storage Gateway Tape Gateway User Guide Best practices for Tape Gateway This section contains the following topics, which provide information about the best practices for working with gateways, local disks, snapshots, and data. We recommend that you familiarize yourself with the information outlined in this section, and attempt to follow these guidelines in order to avoid problems with your AWS Storage Gateway. For additional guidance on diagnosing and solving common issues you might encounter with your deployment, see Troubleshooting your gateway. Topics • Best practices: recovering your data • Cleaning up unecessary resources Best practices: recovering your data Although it is rare, your gateway might encounter an unrecoverable failure. Such a failure can occur in your virtual machine (VM), the gateway itself, the local storage, or elsewhere. If a failure occurs, we recommend that you follow the instructions in the appropriate section following to recover your data. Important Storage Gateway doesn’t support recovering a gateway VM from a snapshot
storagegateway-tgw-ug-113	storagegateway-tgw-ug.pdf	113	AWS Storage Gateway. For additional guidance on diagnosing and solving common issues you might encounter with your deployment, see Troubleshooting your gateway. Topics • Best practices: recovering your data • Cleaning up unecessary resources Best practices: recovering your data Although it is rare, your gateway might encounter an unrecoverable failure. Such a failure can occur in your virtual machine (VM), the gateway itself, the local storage, or elsewhere. If a failure occurs, we recommend that you follow the instructions in the appropriate section following to recover your data. Important Storage Gateway doesn’t support recovering a gateway VM from a snapshot that is created by your hypervisor or from your Amazon EC2 Amazon Machine Image (AMI). If your gateway VM malfunctions, activate a new gateway and recover your data to that gateway using the instructions following. Topics • Recovering from an unexpected virtual machine shutdown • Recovering your data from a malfunctioning gateway or VM • Recovering your data from an irrecoverable tape • Recovering your data from a malfunctioning cache disk • Recovering your data from an inaccessible data center Best practices: recovering your data API Version 2013-06-30 283 AWS Storage Gateway Tape Gateway User Guide Recovering from an unexpected virtual machine shutdown If your VM shuts down unexpectedly, for example during a power outage, your gateway becomes unreachable. When power and network connectivity are restored, your gateway becomes reachable and starts to function normally. Following are some steps you can take at that point to help recover your data: • If an outage causes network connectivity issues, you can troubleshoot the issue. For information about how to test network connectivity, see Testing your gateway connection to the internet. • For tapes setups, when your gateway becomes reachable, your tapes go into BOOTSTRAPPING status. This functionality ensures that your locally stored data continues to be synchronized with AWS. For more information on this status, see Understanding Tape Status. • If your gateway malfunctions and issues occur with your volumes or tapes as a result of an unexpected shutdown, you can recover your data. For information about how to recover your data, see the sections following that apply to your scenario. Recovering your data from a malfunctioning gateway or VM If your Tape Gateway or the hypervisor host encounters an unrecoverable failure, you can use the following steps to recover the tapes from the malfunctioning Tape Gateway to another Tape Gateway: 1. Identify the Tape Gateway that you want to use as the recovery target, or create a new one. 2. Deactivate the malfunctioning gateway. 3. Create recovery tapes for each tape that you want to recover and specify the target Tape Gateway. 4. Delete the malfunctioning Tape Gateway. For detailed information on how to recover the tapes from a malfunctioning Tape Gateway to another Tape Gateway, see You Need to Recover a Virtual Tape from a Malfunctioning Tape Gateway. Recovering from an unexpected VM shutdown API Version 2013-06-30 284 AWS Storage Gateway Tape Gateway User Guide Recovering your data from an irrecoverable tape If your tape encounters a failure and the status of the tape is IRRECOVERABLE, we recommend you use one of the following options to recover your data or resolve the failure depending on your situation: • If you need the data on the irrecoverable tape, you can recover the tape to a new gateway. • If you don't need the data on the tape, and the tape has never been archived, you can simply delete the tape from your Tape Gateway. For detailed information about how to recover your data or resolve the failure if your tape is IRRECOVERABLE, see Troubleshooting Irrecoverable Tapes. Recovering your data from a malfunctioning cache disk If your cache disk encounters a failure, we recommend you use the following steps to recover your data depending on your situation: • If the malfunction occurred because a cache disk was removed from your host, shut down the gateway, re-add the disk, and restart the gateway. • If the cache disk is corrupted or not accessible, shut down the gateway, reset the cache disk, reconﬁgure the disk for cache storage, and restart the gateway. For detailed information, see You Need to Recover a Virtual Tape from a Malfunctioning Cache Disk. Recovering your data from an inaccessible data center If your gateway or data center becomes inaccessible for some reason, you can recover your data to another gateway in a diﬀerent data center or recover to a gateway hosted on an Amazon EC2 instance. If you don't have access to another data center, we recommend creating the gateway on an Amazon EC2 instance. The steps you follow depends on the gateway type you are covering the data from. To recover data from a Tape Gateway in an inaccessible data center 1. Create and activate a new
storagegateway-tgw-ug-114	storagegateway-tgw-ug.pdf	114	from a Malfunctioning Cache Disk. Recovering your data from an inaccessible data center If your gateway or data center becomes inaccessible for some reason, you can recover your data to another gateway in a diﬀerent data center or recover to a gateway hosted on an Amazon EC2 instance. If you don't have access to another data center, we recommend creating the gateway on an Amazon EC2 instance. The steps you follow depends on the gateway type you are covering the data from. To recover data from a Tape Gateway in an inaccessible data center 1. Create and activate a new Tape Gateway on an Amazon EC2 host. For more information, see Deploy a customized Amazon EC2 instance for Tape Gateway. Recovering data from an irrecoverable tape API Version 2013-06-30 285 AWS Storage Gateway Tape Gateway User Guide 2. Recover the tapes from the source gateway in the data center to the new gateway you created on Amazon EC2 For more information, see Recovering a Virtual Tape From An Unrecoverable Gateway. Your tapes should be covered to the new Amazon EC2 gateway. Cleaning up unecessary resources If you created the gateway as an example exercise or a test, consider cleaning up to avoid incurring unexpected or unnecessary charges. If you plan to continue using your Tape Gateway, see additional information in Where do I go from here? To clean up resources you don't need 1. Delete tapes from both your gateway's virtual tape library (VTL) and archive. For more information, see Deleting your gateway and removing associated resources. a. Archive any tapes that have the RETRIEVED status in your gateway's VTL. For instructions, see Archiving Tapes. b. Delete any remaining tapes from your gateway's VTL. For instructions, see Deleting virtual tapes from your Tape Gateway. c. Delete any tapes you have in the archive. For instructions, see Deleting virtual tapes from your Tape Gateway. 2. Unless you plan to continue using the Tape Gateway, delete it: For instructions, see Deleting your gateway and removing associated resources. 3. Delete the Storage Gateway VM from your on-premises host. If you created your gateway on an Amazon EC2 instance, terminate the instance. Cleaning up unecessary resources API Version 2013-06-30 286 AWS Storage Gateway Tape Gateway User Guide Additional Storage Gateway Resources This section describes AWS and third-party software, tools, and resources that can help you set up or manage your gateway, and also Storage Gateway quotas. Topics • Deploying and conﬁguring the gateway VM host - Learn how to deploy and conﬁgure a virtual machine host for your gateway. • Working with Tape Gateway storage resources - Learn about procedures related to Tape Gateway storage resources, such as removing local disks, managing Amazon EBS volumes, working with virtual tape library devices, and managing the tapes in your virtual tape library. • Getting an activation key for your gateway - Learn where to ﬁnd the activation key that you need to provide when you deploy a new gateway. • Connecting iSCSI Initiators - Learn how to work with volumes or virtual tape library (VTL) devices that are exposed as Internet Small Computer System Interface (iSCSI) targets. • Using AWS Direct Connect with Storage Gateway - Learn how to create a dedicated network connection between your on-premises gateway and the AWS cloud. • Getting the IP address for your gateway appliance - Learn where to ﬁnd the gateway's virtual machine host IP address, which you need to provide when you deploy a new gateway. • Understanding Storage Gateway Resources and Resource IDs - Learn how AWS identiﬁes the resources and subresources that are created by Storage Gateway. • Tagging Storage Gateway Resources - Learn how to use metadata tags to categorize your resources and make them easier to manage. • Working with open-source components for Storage Gateway - Learn about the third-party tools and licenses that are used to deliver Storage Gateway functionality. • AWS Storage Gateway quotas - Learn about limits and quotas for Tape Gateway, including maximum limitations for tape size and quantity, and local disk size recommendations. Deploying and conﬁguring the gateway VM host The topics in this section describe how to set up and manage the virtual machine host for your Storage Gateway appliance, including on-premises appliances running on VMware, Hyper-V, or Linux KVM, and appliances running on Amazon EC2 instances in the AWS cloud. Host setup API Version 2013-06-30 287 AWS Storage Gateway Topics Tape Gateway User Guide • Deploy a default Amazon EC2 host for Tape Gateway - Learn about how to deploy and activate a Tape Gateway on an Amazon Elastic Compute Cloud (Amazon EC2) instance using the default speciﬁcations. • Deploy a customized Amazon EC2 instance for Tape Gateway - Learn about how to deploy and activate a Tape Gateway on an Amazon Elastic Compute Cloud (Amazon EC2)
storagegateway-tgw-ug-115	storagegateway-tgw-ug.pdf	115	Gateway appliance, including on-premises appliances running on VMware, Hyper-V, or Linux KVM, and appliances running on Amazon EC2 instances in the AWS cloud. Host setup API Version 2013-06-30 287 AWS Storage Gateway Topics Tape Gateway User Guide • Deploy a default Amazon EC2 host for Tape Gateway - Learn about how to deploy and activate a Tape Gateway on an Amazon Elastic Compute Cloud (Amazon EC2) instance using the default speciﬁcations. • Deploy a customized Amazon EC2 instance for Tape Gateway - Learn about how to deploy and activate a Tape Gateway on an Amazon Elastic Compute Cloud (Amazon EC2) instance using customized settings. • Modify Amazon EC2 instance metadata options - Learn about how to conﬁgure your Amazon EC2 gateway instance to accept incoming metadata requests that use IMDS Version 1 (IMDSv1) or require that all metadata requests use IMDS Version 2 (IMDSv2). • Synchronize VM time with Hyper-V or Linux KVM host time - Learn about how to view and synchronize the time of an on-premises Hyper-V or Linux KVM gateway virtual machine to a Network Time Protocol (NTP) server. • Synchronize VM time with VMware host time - Learn about how to check the host time for a VMware gateway virtual machine and, if needed, set the time and conﬁgure the host to synchronize its time automatically to a Network Time Protocol (NTP) server. • Conﬁguring paravirtualization on a VMware host - Learn about how you can conﬁgure the VMware host platform for your Storage Gateway appliance to use paravirtual Internet Small Computer System Interface Protocol (iSCSI) controllers. • Conﬁguring network adapters for your gateway - Learn about how you can reconﬁgure your gateway to use the VMXNET3 (10 GbE) network adapter, or to use more than one network adapter so that it can be accessed fron nultiple IP addresses. • Using VMware vSphere High Availability with Storage Gateway - Learn about how to protect your storage workloads against hardware, hypervisor, or network failures by conﬁguring Storage Gateway to work with VMware vSphere High Availability. Deploy a default Amazon EC2 host for Tape Gateway This topic lists the steps to deploy an Amazon EC2 host using the default speciﬁcations. You can deploy and activate a Tape Gateway on an Amazon Elastic Compute Cloud (Amazon EC2) instance. The AWS Storage Gateway Amazon Machine Image (AMI) is available as a community AMI. Deploy a default Amazon EC2 host for Tape Gateway API Version 2013-06-30 288 AWS Storage Gateway Note Tape Gateway User Guide Storage Gateway community AMIs are published and fully supported by AWS. You can see that the publisher is AWS, a veriﬁed provider. 1. 2. To set up the Amazon EC2instance, choose Amazon EC2 as the Host platform in the Platform options section of the workﬂow. For instructions on conﬁguring the Amazon EC2 instance, see Deploying an Amazon EC2 instance to host your Tape Gateway. Select Launch instance to open the AWS Storage Gateway AMI template in the Amazon EC2 console and customize additional settings such as Instance types, Network settings and Conﬁgure storage. 3. Optionally, you can select Use default settings in the Storage Gateway console to deploy an Amazon EC2 instance with the default conﬁguration. The Amazon EC2 instance that Use default settings creates has the following default speciﬁcations: • Instance type — m5.xlarge • Network Settings • For VPC, select the VPC that you want your EC2 instance to run in. • For Subnet, specify the subnet that your EC2 instance should be launched in. Note VPC subnets will appear in the drop down only if they have the auto-assign public IPv4 address setting activated from the VPC management console. • Auto-assign Public IP — Activated An EC2 security group is created and associated with the EC2 instance. The security group has the following inbound port rules: Deploy a default Amazon EC2 host for Tape Gateway API Version 2013-06-30 289 AWS Storage Gateway Tape Gateway User Guide Note You will need Port 80 open during gateway activation. The port is closed immediately following activation. Thereafter, your EC2 instance can only be accessed over the other ports from the selected VPC. The iSCSI targets on your gateway are only accessible from the hosts in the same VPC as the gateway. If the iSCSI targets need to be accessed from hosts outside of the VPC, you should update the appropriate security group rules. You can edit security groups at any time by navigating to the Amazon EC2 instance details page, selecting Security, navigating to Security group details, and choosing the security group ID. Port Protocol 80 TCP File System Protocol HTTP access for activation 3260 TCP iSCSI • Conﬁgure storage Default Settings AMI Root Volume Volume 2 Cache Volume 3 Cache Device Name '/dev/sdb' '/dev/sdc' Size 80 Gib 165 GiB 150 GiB Volume Type gp3 gp3
storagegateway-tgw-ug-116	storagegateway-tgw-ug.pdf	116	same VPC as the gateway. If the iSCSI targets need to be accessed from hosts outside of the VPC, you should update the appropriate security group rules. You can edit security groups at any time by navigating to the Amazon EC2 instance details page, selecting Security, navigating to Security group details, and choosing the security group ID. Port Protocol 80 TCP File System Protocol HTTP access for activation 3260 TCP iSCSI • Conﬁgure storage Default Settings AMI Root Volume Volume 2 Cache Volume 3 Cache Device Name '/dev/sdb' '/dev/sdc' Size 80 Gib 165 GiB 150 GiB Volume Type gp3 gp3 gp3 IOPS 3000 3000 3000 Deploy a default Amazon EC2 host for Tape Gateway API Version 2013-06-30 290 AWS Storage Gateway Tape Gateway User Guide Default Settings AMI Root Volume Volume 2 Cache Volume 3 Cache Yes Yes Yes Delete on terminati on Encrypted No Throughpu t 125 No 125 No 125 Deploy a customized Amazon EC2 instance for Tape Gateway You can deploy and activate a Tape Gateway on an Amazon Elastic Compute Cloud (Amazon EC2) instance. The AWS Storage Gateway Amazon Machine Image (AMI) is available as a community AMI. Note Storage Gateway community AMIs are published and fully supported by AWS. You can see that the publisher is AWS, a veriﬁed provider. Tape Gateway AMIs use the following naming convention. The version number appended to the AMI name changes with each version release. aws-storage-gateway-CLASSIC-2.9.0 To deploy an Amazon EC2 instance to host your Tape Gateway 1. Start setting up a new gateway using the Storage Gateway console. For instructions, see Set up a Tape Gateway. When you reach the Platform options section, choose Amazon EC2 as the Host platform, then use the following steps to launch the Amazon EC2 instance that will host your Tape Gateway. 2. Choose Launch instance to open the AWS Storage Gateway AMI template in the Amazon EC2 console, where you can conﬁgure additional settings. Use Quicklaunch to launch the Amazon EC2 instance with default settings. For more information on Amazon EC2 Quicklaunch default sepciﬁcations, see Quicklaunch Conﬁguration Speciﬁcations for Amazon EC2. Deploy a customized Amazon EC2 instance for Tape Gateway API Version 2013-06-30 291 AWS Storage Gateway Tape Gateway User Guide 3. 4. For Name, enter a name for the Amazon EC2 instance. After the instance is deployed, you can search for this name to ﬁnd your instance on list pages in the Amazon EC2 console. In the Instance type section, for Instance type, choose the hardware conﬁguration for your instance. The hardware conﬁguration must meet certain minimum requirements to support your gateway. We recommend starting with the m5.xlarge instance type, which meets the minimum hardware requirements for your gateway to function properly. For more information, see Requirements for Amazon EC2 instance types. You can resize your instance after you launch, if necessary. For more information, see Resizing your instance in the Amazon EC2 User Guide. Note Certain instance types, particularly i3 EC2, use NVMe SSD disks. These can cause problems when you start or stop Tape Gateway; for example, you can lose data from the cache. Monitor the CachePercentDirty Amazon CloudWatch metric, and only start or stop your system when that parameter is 0. To learn more about monitoring metrics for your gateway, see Storage Gateway metrics and dimensions in the CloudWatch documentation. 5. In the Key pair (login) section, for Key pair name - required, select the key pair you want to use to securely connect to your instance. You can create a new key pair if necessary. For more information, see Create a key pair in the Amazon Elastic Compute Cloud User Guide for Linux Instances. 6. In the Network settings section, review the preconﬁgured settings and choose Edit to make changes to the following ﬁelds: a. b. For VPC - required, choose the VPC where you want to launch your Amazon EC2 instance. For more information, see How Amazon VPC works in the Amazon Virtual Private Cloud User Guide. (Optional) For Subnet, choose the subnet where you want to launch your Amazon EC2 instance. c. For Auto-assign Public IP, choose Enable. 7. In the Firewall (security groups) subsection, review the preconﬁgured settings. You can change the default name and description of the new security group to be created for your Amazon EC2 instance if you want, or choose to apply ﬁrewall rules from an existing security group instead. Deploy a customized Amazon EC2 instance for Tape Gateway API Version 2013-06-30 292 AWS Storage Gateway Tape Gateway User Guide 8. In the Inbound security groups rules subsection, add ﬁrewall rules to open the ports that clients will use to connect to your instance. For more information on the ports required for Tape Gateway, see Port requirements. For more information on adding ﬁrewall rules, see Security group rules in the
storagegateway-tgw-ug-117	storagegateway-tgw-ug.pdf	117	and description of the new security group to be created for your Amazon EC2 instance if you want, or choose to apply ﬁrewall rules from an existing security group instead. Deploy a customized Amazon EC2 instance for Tape Gateway API Version 2013-06-30 292 AWS Storage Gateway Tape Gateway User Guide 8. In the Inbound security groups rules subsection, add ﬁrewall rules to open the ports that clients will use to connect to your instance. For more information on the ports required for Tape Gateway, see Port requirements. For more information on adding ﬁrewall rules, see Security group rules in the Amazon Elastic Compute Cloud User Guide for Linux Instances. Note Tape Gateway requires TCP port 80 to be open for inbound traﬃc and for one-time HTTP access during gateway activation. After activation, you can close this port. Additionally, you must open TCP port 3260 for iSCSI access. 9. In the Advanced network conﬁguration subsection, review the preconﬁgured settings and make changes if necessary. 10. In the Conﬁgure storage section, choose Add new volume to add storage to your gateway instance. Important You must add at least one Amazon EBS volume with at least 165 GiB capacity for cache storage, and at least one Amazon EBS volume with at least 150 GiB capacity for upload buﬀer, in addition to the preconﬁgured Root volume. For increased performance, we recommend allocating multiple EBS volumes for cache storage with at least 150 GiB each. 11. In the Advanced details section, review the preconﬁgured settings and make changes if necessary. 12. Choose Launch instance to launch your new Amazon EC2 gateway instance with the conﬁgured settings. 13. To verify that your new instance launched successfully, navigate to the Instances page in the Amazon EC2 console and search for your new instance by name. Ensure that that Instance state displays Running with a green check mark, and that the Status check is complete, and shows a green check mark. 14. Select your instance from the details page. Copy the Public IPv4 address from the Instance summary section, then return to the Set up gateway page in the Storage Gateway console to resume setting up your Tape Gateway. Deploy a customized Amazon EC2 instance for Tape Gateway API Version 2013-06-30 293 AWS Storage Gateway Tape Gateway User Guide You can determine the AMI ID to use for launching a Tape Gateway by using the Storage Gateway console or by querying the AWS Systems Manager parameter store. To determine the AMI ID, do one of the following: • Start setting up a new gateway using the Storage Gateway console. For instructions, see Set up a Tape Gateway. When you reach the Platform options section, choose Amazon EC2 as the Host platform, then choose Launch instance to open the AWS Storage Gateway AMI template in the Amazon EC2 console. You are redirected to the EC2 community AMI page, where you can see the AMI ID for your AWS Region in the URL. • Query the Systems Manager parameter store. You can use the AWS CLI or Storage Gateway API to query the Systems Manager public parameter under the namespace /aws/service/ storagegateway/ami/VTL/latest. For example, using the following CLI command returns the ID of the current AMI in the AWS Region you specify. aws --region us-east-2 ssm get-parameter --name /aws/service/storagegateway/ami/VTL/ latest The CLI command returns output similar to the following. { "Parameter": { "Type": "String", "LastModifiedDate": 1561054105.083, "Version": 4, "ARN": "arn:aws:ssm:us-east-2::parameter/aws/service/storagegateway/ami/VTL/ latest", "Name": "/aws/service/storagegateway/ami/VTL/latest", "Value": "ami-123c45dd67d891000" } } Modify Amazon EC2 instance metadata options The instance metadata service (IMDS) is an on-instance component that provides secure access to Amazon EC2 instance metadata. An instance can be conﬁgured to accept incoming metadata requests that use IMDS Version 1 (IMDSv1) or require that all metadata requests use IMDS Version Modify Amazon EC2 instance metadata options API Version 2013-06-30 294 AWS Storage Gateway Tape Gateway User Guide 2 (IMDSv2). IMDSv2 uses session-oriented requests and mitigates several types of vulnerabilities that could be used to try to access the IMDS. For information about IMDSv2, see How Instance Metadata Service Version 2 works in the Amazon Elastic Compute Cloud User Guide. We recommend that you require IMDSv2 for all Amazon EC2 instances that host Storage Gateway. IMDSv2 is required by default on all newly launched gateway instances. If you have existing instances that are still conﬁgured to accept IMDSv1 metadata requests, see Require the use of IMDSv2 in the Amazon Elastic Compute Cloud User Guide for instructions to modify your instance metadata options to require the use of IMDSv2. Applying this change does not require an instance reboot. Synchronize VM time with Hyper-V or Linux KVM host time For a gateway deployed on VMware ESXi, setting the hypervisor host time and synchronizing the virtual machine time to the host is suﬃcient to avoid time drift. For
storagegateway-tgw-ug-118	storagegateway-tgw-ug.pdf	118	IMDSv2 is required by default on all newly launched gateway instances. If you have existing instances that are still conﬁgured to accept IMDSv1 metadata requests, see Require the use of IMDSv2 in the Amazon Elastic Compute Cloud User Guide for instructions to modify your instance metadata options to require the use of IMDSv2. Applying this change does not require an instance reboot. Synchronize VM time with Hyper-V or Linux KVM host time For a gateway deployed on VMware ESXi, setting the hypervisor host time and synchronizing the virtual machine time to the host is suﬃcient to avoid time drift. For more information, see Synchronize VM time with VMware host time. For a gateway deployed on Microsoft Hyper-V or Linux KVM, we recommend that you periodically check the virtual machine time using the procedure described following. To view and synchronize the time of a hypervisor gateway virtual machine to a Network Time Protocol (NTP) server 1. Log in to your gateway's local console: • 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 local console for Linux Kernel-based Virtual Machine (KVM), see Accessing the Gateway Local Console with Linux KVM. 2. On the Storage Gateway Conﬁguration main menu screen, enter the corresponding numeral to select System Time Management. 3. On the System Time Management menu screen, enter the corresponding numeral to select View and Synchronize System Time. The gateway local console displays the current system time and compares it with the time reported by the NTP server, then reports the exact discrepancy between the two times in seconds. 4. If the time discrepancy is greater than 60 seconds, enter y to synchronize the system time with NTP time. Otherwise, enter n. Synchronize VM time with Hyper-V or Linux KVM host time API Version 2013-06-30 295 AWS Storage Gateway Tape Gateway User Guide Time synchronization might take a few moments. Synchronize VM time with VMware host time To successfully activate your gateway, you must ensure that your VM time is synchronized to the host time, and that the host time is correctly set. In this section, you ﬁrst synchronize the time on the VM to the host time. Then you check the host time and, if needed, set the host time and conﬁgure the host to synchronize its time automatically to a Network Time Protocol (NTP) server. Important Synchronizing the VM time with the host time is required for successful gateway activation. To synchronize VM time with host time 1. Conﬁgure your VM time. a. In the vSphere client, right-click on the name of your gateway VM in panel on the left side of the application window to open the context menu for the VM, and then choose Edit Settings. The Virtual Machine Properties dialog box opens. b. Choose the Options tab, and then choose VMware Tools from the options list. c. Check the Synchronize guest time with host option in the Advanced section on the right side of the Virtual Machine Properties dialog box, and then choose OK. The VM synchronizes its time with the host. 2. Conﬁgure the host time. It is important to make sure that your host clock is set to the correct time. If you have not conﬁgured your host clock, perform the following steps to set and synchronize it with an NTP server. a. In the VMware vSphere client, select the vSphere host node in the left panel, and then choose the Conﬁguration tab. b. Select Time Conﬁguration in the Software panel, and then choose the Properties link. Synchronize VM time with VMware host time API Version 2013-06-30 296 AWS Storage Gateway Tape Gateway User Guide The Time Conﬁguration dialog box appears. c. Under Date and Time, set the date and time for your vSphere host. d. Conﬁgure the host to synchronize its time automatically to an NTP server. i. Choose Options in the Time Conﬁguration dialog box, and then in the NTP Daemon (ntpd) Options dialog box, choose NTP Settings in the left panel. ii. Choose Add to add a new NTP server. iii. In the Add NTP Server dialog box, type the IP address or the fully qualiﬁed domain name of an NTP server, and then choose OK. You can use pool.ntp.org as the domain name. iv. In the NTP Daemon (ntpd) Options dialog box, choose General in the left panel. v. Under Service Commands, choose Start to start the service. Note that if you change this NTP server reference or add another later, you will need to restart the service to use the new server. e. f. Choose OK to close the NTP Daemon (ntpd) Options dialog box. Choose OK to close the Time Conﬁguration dialog box. Conﬁguring paravirtualization on a VMware
storagegateway-tgw-ug-119	storagegateway-tgw-ug.pdf	119	address or the fully qualiﬁed domain name of an NTP server, and then choose OK. You can use pool.ntp.org as the domain name. iv. In the NTP Daemon (ntpd) Options dialog box, choose General in the left panel. v. Under Service Commands, choose Start to start the service. Note that if you change this NTP server reference or add another later, you will need to restart the service to use the new server. e. f. Choose OK to close the NTP Daemon (ntpd) Options dialog box. Choose OK to close the Time Conﬁguration dialog box. Conﬁguring paravirtualization on a VMware host The following procedure describes how to conﬁgure the VMware host platform for your Storage Gateway appliance to use paravirtual Internet Small Computer System Interface Protocol (iSCSI) controllers. Paravirtual iSCSI controllers are high performance storage controllers that can result in greater throughput and lower CPU use. These controllers are best suited for high performance storage environments. When you conﬁgure iSCSI controllers this way, the Storage Gateway virtual machine works with the host operating system to allow the gateway console to identify the virtual disks that you add to your virtual machine. Note You need to complete this step to avoid issues in identifying these disks when you conﬁgure them in the gateway console. Conﬁgure paravirtualized disk controllers API Version 2013-06-30 297 AWS Storage Gateway Tape Gateway User Guide To conﬁgure your VMware host platform to use paravirtualized controllers 1. In the VMware vSphere client, right-click on the name of your gateway virtual machine in the navigation pane on the left side of the application window to open the context menu, and then choose Edit Settings. 2. In the Virtual Machine Properties dialog box, choose the Hardware tab. 3. On the Hardware tab, select SCSI controller 0, and then choose Change Type. 4. In the Change SCSI Controller Type dialog box, select the VMware Paravirtual SCSI controller type, and then choose OK to save the conﬁguration. Conﬁguring network adapters for your gateway By default, Storage Gateway is conﬁgured to use the E1000 network adapter type, but you can reconﬁgure your gateway to use the VMXNET3 (10 GbE) network adapter. You can also conﬁgure Storage Gateway so it can be accessed by more than one IP address. You do this by conﬁguring your gateway to use more than one network adapter. Topics • Conﬁguring Your Gateway to Use the VMXNET3 Network Adapter • Conﬁguring Your Gateway for Multiple NICs Conﬁguring Your Gateway to Use the VMXNET3 Network Adapter Storage Gateway supports the E1000 network adapter type in both VMware ESXi and Microsoft Hyper-V hypervisor hosts. However, the VMXNET3 (10 GbE) network adapter type is supported in VMware ESXi hypervisor only. If your gateway is hosted on a VMware ESXi hypervisor, you can reconﬁgure your gateway to use the VMXNET3 (10 GbE) adapter type. For more information on these adapters, see Choosing a network adapter for your virtual machine on the Broadcom (VMware) website. Important To select VMXNET3, your guest operating system type must be Other Linux64. Following are the steps you take to conﬁgure your gateway to use the VMXNET3 adapter: Conﬁguring network adapters for your gateway API Version 2013-06-30 298 AWS Storage Gateway Tape Gateway User Guide 1. Remove the default E1000 adapter. 2. Add the VMXNET3 adapter. 3. Restart your gateway. 4. Conﬁgure the adapter for the network. Details on how to perform each step follow. To remove the default E1000 adapter and conﬁgure your gateway to use the VMXNET3 adapter 1. 2. 3. In VMware, open the context (right-click) menu for your gateway and choose Edit Settings. In the Virtual Machine Properties window, choose the Hardware tab. For Hardware, choose Network adapter. Notice that the current adapter is E1000 in the Adapter Type section. You will replace this adapter with the VMXNET3 adapter. 4. Choose the E1000 network adapter, and then choose Remove. In this example, the E1000 network adapter is Network adapter 1. Note Although you can run the E1000 and VMXNET3 network adapters in your gateway at the same time, we don't recommend doing so because it can cause network problems. 5. Choose Add to open the Add Hardware wizard. 6. Choose Ethernet Adapter, and then choose Next. 7. 8. In the Network Type wizard, select VMXNET3 for Adapter Type, and then choose Next. In the Virtual Machine properties wizard, verify in the Adapter Type section that Current Adapter is set to VMXNET3, and then choose OK. 9. In the VMware VSphere client, shut down your gateway. 10. In the VMware VSphere client, restart your gateway. After your gateway restarts, reconﬁgure the adapter you just added to make sure that network connectivity to the internet is established. Conﬁguring network adapters for your gateway API Version 2013-06-30 299 AWS Storage Gateway Tape Gateway User Guide To conﬁgure the
storagegateway-tgw-ug-120	storagegateway-tgw-ug.pdf	120	Next. 7. 8. In the Network Type wizard, select VMXNET3 for Adapter Type, and then choose Next. In the Virtual Machine properties wizard, verify in the Adapter Type section that Current Adapter is set to VMXNET3, and then choose OK. 9. In the VMware VSphere client, shut down your gateway. 10. In the VMware VSphere client, restart your gateway. After your gateway restarts, reconﬁgure the adapter you just added to make sure that network connectivity to the internet is established. Conﬁguring network adapters for your gateway API Version 2013-06-30 299 AWS Storage Gateway Tape Gateway User Guide To conﬁgure the adapter for the network 1. In the VSphere client, choose the Console tab to start the local console. Use the default login credentials to log in to the gateway's local console for this conﬁguration task. For information about how to log in using the default credentials, see Logging in to the Local Console Using Default Credentials. 2. At the prompt, enter the corresponding numeral to select Network Conﬁguration. 3. At the prompt, enter the corresponding numeral to select Reset all to DHCP, and then enter y (for yes) at the prompt to set all adapters to use Dynamic Host Conﬁguration Protocol (DHCP). All available adapters are set to use DHCP. If your gateway is already activated, you must shut it down and restart it from the Storage Gateway Management Console. After the gateway restarts, you must test network connectivity to the internet. For information about how to test network connectivity, see Testing Your Gateway Connection to the Internet. Conﬁguring Your Gateway for Multiple NICs If you conﬁgure your gateway to use multiple network adapters (NICs), it can be accessed by more than one IP address. You might want to do this in the following situations: • Maximizing throughput – You might want to maximize throughput to a gateway when network adapters are a bottleneck. • Application separation – You might need to separate how your applications write to a gateway's volumes. For example, you might choose to have a critical storage application exclusively use one particular adapter deﬁned for your gateway. • Network constraints – Your application environment might require that you keep your iSCSI targets and the initiators that connect to them in an isolated network that is diﬀerent from the network by which the gateway communicates with AWS. In a typical multiple-adapter use case, one adapter is conﬁgured as the route by which the gateway communicates with AWS (that is, as the default gateway). Except for this one adapter, initiators must be in the same subnet as the adapter that contains the iSCSI targets to which they connect. Otherwise, communication with the intended targets might not be possible. If a target is conﬁgured on the same adapter that is used for communication with AWS, then iSCSI traﬃc for that target and AWS traﬃc will ﬂow through the same adapter. Conﬁguring network adapters for your gateway API Version 2013-06-30 300 AWS Storage Gateway Tape Gateway User Guide When you conﬁgure one adapter to connect to the Storage Gateway console and then add a second adapter, Storage Gateway automatically conﬁgures the route table to use the second adapter as the preferred route. For instructions on how to conﬁgure multiple-adapters, see the following sections. • Conﬁguring multiple network adapters on a VMware ESXi host • Conﬁguring multiple network adapters on Microsoft Hyper-V host Conﬁguring multiple network adapters on a VMware ESXi host The following procedure assumes that your gateway VM already has one network adapter deﬁned, and describes how to add an adapter on VMware ESXi. To conﬁgure your gateway to use an additional network adapter in VMware ESXi host 1. 2. 3. Shut down the gateway. In the VMware vSphere client, select your gateway VM. The VM can remain turned on for this procedure. In the client, open the context (right-click) menu for your gateway VM, and choose Edit Settings. 4. On the Hardware tab of the Virtual Machine Properties dialog box, choose Add to add a device. 5. Follow the Add Hardware wizard to add a network adapter. a. b. In the Device Type pane, choose Ethernet Adapter to add an adapter, and then choose Next. In the Network Type pane, ensure that Connect at power on is selected for Type, and then choose Next. We recommend that you use the VMXNET3 network adapter with Storage Gateway. For more information on the adapter types that might appear in the adapter list, see Network Adapter Types in the ESXi and vCenter Server Documentation. c. In the Ready to Complete pane, review the information, and then choose Finish. 6. Choose the Summary tab for the VM, and choose View All next to the IP Address box. The Virtual Machine IP Addresses window displays all the IP addresses you can use to
storagegateway-tgw-ug-121	storagegateway-tgw-ug.pdf	121	Type pane, ensure that Connect at power on is selected for Type, and then choose Next. We recommend that you use the VMXNET3 network adapter with Storage Gateway. For more information on the adapter types that might appear in the adapter list, see Network Adapter Types in the ESXi and vCenter Server Documentation. c. In the Ready to Complete pane, review the information, and then choose Finish. 6. Choose the Summary tab for the VM, and choose View All next to the IP Address box. The Virtual Machine IP Addresses window displays all the IP addresses you can use to access the gateway. Conﬁrm that a second IP address is listed for the gateway. Conﬁguring network adapters for your gateway API Version 2013-06-30 301 AWS Storage Gateway Note Tape Gateway User Guide It might take several moments for the adapter changes to take eﬀect and the VM summary information to refresh. 7. 8. In the Storage Gateway console, turn on the gateway. In the Navigation pane of the Storage Gateway console, choose Gateways and choose the gateway to which you added the adapter. Conﬁrm that the second IP address is listed in the Details tab. For information about local console tasks common to VMware, Hyper-V, and KVM hosts, see Performing Tasks on the VM Local Console Conﬁguring multiple network adapters on Microsoft Hyper-V host The following procedure assumes that your gateway VM already has one network adapter deﬁned and that you are adding a second adapter. This procedure shows how to add an adapter for a Microsoft Hyper-V host. To conﬁgure your gateway to use an additional network adapter in a Microsoft Hyper-V Host 1. On the Storage Gateway console, turn oﬀ the gateway. 2. 3. In the Microsoft Hyper-V Manager, select your gateway VM from the Virtual Machines panel. If the gateway VM isn't turned oﬀ already, right-click the VM name to open the context menu, and then choose Turn Oﬀ. 4. Right-click the gateway VM name to open the context menu, and then choose Settings. 5. 6. In the Settings dialog box, under Hardware, choose Add Hardware. In the Add Hardware panel on the right side of the Settings dialog box, choose Network Adapter, and then choose Add to add a device. 7. Conﬁgure the network adapter, and then choose Apply to apply settings. 8. In the Settings dialog box, under Hardware, conﬁrm that the new network adapter was added to the hardware list, and then choose OK. 9. Turn on the gateway using the Storage Gateway console. Conﬁguring network adapters for your gateway API Version 2013-06-30 302 AWS Storage Gateway Tape Gateway User Guide 10. In the Navigation panel of the Storage Gateway console, choose Gateways, then select the gateway to which you added the adapter. Conﬁrm that a second IP address is listed in the Details tab. For information about local console tasks common to VMware, Hyper-V, and KVM hosts, see Performing Tasks on the VM Local Console Using VMware vSphere High Availability with Storage Gateway Storage Gateway provides high availability on VMware through a set of application-level health checks integrated with VMware vSphere High Availability (VMware HA). This approach helps protect storage workloads against hardware, hypervisor, or network failures. It also helps protect against software errors, such as connection timeouts and ﬁle share or volume unavailability. vSphere HA works by pooling virtual machines and the hosts they reside on into a cluster for redundancy. Hosts in the cluster are monitored and in the event of a failure, the virtual machines on a failed host are restarted on alternate hosts. Generally, this recovery happens quickly and without data loss. For more information about vSphere HA, see How vSphere HA Works in the VMware documentation. Note The time required to restart a failed virtual machine and re-establish the iSCSI connection on a new host depends on many factors, such as the host operating system and resource load, disk speed, network connection, and SAN/storage infrastructure. To minimize failover downtime, implement the recommendations outlined in Optimizing Gateway Performance. To use Storage Gateway with VMware HA, we recommend doing the following things: • Deploy the VMware ESX .ova downloadable package that contains the Storage Gateway VM on only one host in a cluster. • When deploying the .ova package, select a data store that is not local to one host. Instead, use a data store that is accessible to all hosts in the cluster. If you select a data store that is local to a host and the host fails, then the data source might not be accessible to other hosts in the cluster and failover to another host might not succeed. • To prevent your initiator from disconnecting from storage volume targets during failover, follow the recommended iSCSI settings for your operating system. In a failover event, it can
storagegateway-tgw-ug-122	storagegateway-tgw-ug.pdf	122	in a cluster. • When deploying the .ova package, select a data store that is not local to one host. Instead, use a data store that is accessible to all hosts in the cluster. If you select a data store that is local to a host and the host fails, then the data source might not be accessible to other hosts in the cluster and failover to another host might not succeed. • To prevent your initiator from disconnecting from storage volume targets during failover, follow the recommended iSCSI settings for your operating system. In a failover event, it can take from a few seconds to several minutes for a gateway VM to start in a new host in the failover cluster. The recommended iSCSI timeouts for both Windows and Using VMware High Availability with Storage Gateway API Version 2013-06-30 303 AWS Storage Gateway Tape Gateway User Guide Linux clients are greater than the typical time it takes for failover to occur. For more information on customizing Windows clients' timeout settings, see Customizing Your Windows iSCSI Settings. For more information on customizing Linux clients' timeout settings, see Customizing Your Linux iSCSI Settings. • With clustering, if you deploy the .ova package to the cluster, select a host when you are prompted to do so. Alternately, you can deploy directly to a host in a cluster. The following topics describe how to deploy Storage Gateway in a VMware HA cluster: Topics • Conﬁgure Your vSphere VMware HA Cluster • Download the .ova Image from the Storage Gateway console • Deploy the Gateway • (Optional) Add Override Options for Other VMs on Your Cluster • Activate Your Gateway • Test Your VMware High Availability Conﬁguration Conﬁgure Your vSphere VMware HA Cluster First, if you haven’t already created a VMware cluster, create one. For information about how to create a VMware cluster, see Create a vSphere HA Cluster in the VMware documentation. Next, conﬁgure your VMware cluster to work with Storage Gateway. To conﬁgure your VMware cluster 1. On the Edit Cluster Settings page in VMware vSphere, make sure that VM monitoring is conﬁgured for VM and application monitoring. To do so, set the following values for each option: • Host Failure Response: Restart VMs • Response for Host Isolation: Shut down and restart VMs • Datastore with PDL: Disabled • Datastore with APD: Disabled • VM Monitoring: VM and Application Monitoring Using VMware High Availability with Storage Gateway API Version 2013-06-30 304 AWS Storage Gateway Tape Gateway User Guide 2. Fine-tune the sensitivity of the cluster by adjusting the following values: • Failure interval – After this interval, the VM is restarted if a VM heartbeat isn't received. • Minimum uptime – The cluster waits this long after a VM starts to begin monitoring for VM tools' heartbeats. • Maximum per-VM resets – The cluster restarts the VM a maximum of this many times within the maximum resets time window. • Maximum resets time window – The window of time in which to count the maximum resets per-VM resets. If you aren't sure what values to set, use these example settings: • Failure interval: 30 seconds • Minimum uptime: 120 seconds • Maximum per-VM resets: 3 • Maximum resets time window: 1 hour If you have other VMs running on the cluster, you might want to set these values speciﬁcally for your VM. You can't do this until you deploy the VM from the .ova. For more information on setting these values, see (Optional) Add Override Options for Other VMs on Your Cluster. Download the .ova Image from the Storage Gateway console To download the .ova image for your gateway • On the Set up gateway page in the Storage Gateway console, select your gateway type and host platform, then use the link provided in the console to download the .ova as outlined in Set up a Tape Gateway. Deploy the Gateway In your conﬁgured cluster, deploy the .ova image to one of the cluster's hosts. To deploy the gateway .ova image 1. Deploy the .ova image to one of the hosts in the cluster. Using VMware High Availability with Storage Gateway API Version 2013-06-30 305 AWS Storage Gateway Tape Gateway User Guide 2. Make sure the data stores that you choose for the root disk and the cache are available to all hosts in the cluster. When deploying the Storage Gateway .ova ﬁle in a VMware or on-prem environment, the disks are described as paravirtualized SCSI disks. Paravirtualization is a mode where the gateway VM works with the host operating system so the console can identify the virtual disks that you add to your VM. To conﬁgure your VM to use paravirtualized controllers 1. In the VMware vSphere client, open the context (right-click) menu for your gateway VM, and then choose
storagegateway-tgw-ug-123	storagegateway-tgw-ug.pdf	123	Guide 2. Make sure the data stores that you choose for the root disk and the cache are available to all hosts in the cluster. When deploying the Storage Gateway .ova ﬁle in a VMware or on-prem environment, the disks are described as paravirtualized SCSI disks. Paravirtualization is a mode where the gateway VM works with the host operating system so the console can identify the virtual disks that you add to your VM. To conﬁgure your VM to use paravirtualized controllers 1. In the VMware vSphere client, open the context (right-click) menu for your gateway VM, and then choose Edit Settings. 2. In the Virtual Machine Properties dialog box, choose the Hardware tab, select the SCSI controller 0, and then choose Change Type. 3. In the Change SCSI Controller Type dialog box, select the VMware Paravirtual SCSI controller type, and then choose OK. (Optional) Add Override Options for Other VMs on Your Cluster If you have other VMs running on your cluster, you might want to set the cluster values speciﬁcally for each VM. For instructions, see Customize an Individual Virtual Machine in the VMware vSphere online documentation. To add override options for other VMs on your cluster 1. On the Summary page in VMware vSphere, choose your cluster to open the cluster page, and then choose Conﬁgure. 2. Choose the Conﬁguration tab, and then choose VM Overrides. 3. Add a new VM override option to change each value. Set the following values for each option under vSphere HA - VM Monitoring: • VM Monitoring: Override Enabled - VM and Application Monitoring • VM monitoring sensitivity: Override Enabled - VM and Application Monitoring • VM Monitoring: Custom • Failure interval: 30 seconds • Minimum uptime: 120 seconds • Maximum per-VM resets: 5 Using VMware High Availability with Storage Gateway API Version 2013-06-30 306 AWS Storage Gateway Tape Gateway User Guide • Maximum resets time window: Within 1 hrs Activate Your Gateway After the .ova for your gateway is deployed, activate your gateway. The instructions about how are diﬀerent for each gateway type. To activate your gateway • Follow the procedures outlined in the following topics: a. Connect your Tape Gateway to AWS b. Review settings and activate your Tape Gateway c. Conﬁgure your Tape Gateway Test Your VMware High Availability Conﬁguration After you activate your gateway, test your conﬁguration. To test your VMware HA conﬁguration 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 that you want to test for VMware HA. For Actions, choose Verify VMware HA. In the Verify VMware High Availability Conﬁguration box that appears, choose OK. 3. 4. Note Testing your VMware HA conﬁguration reboots your gateway VM and interrupts connectivity to your gateway. The test might take a few minutes to complete. If the test is successful, the status of Veriﬁed appears in the details tab of the gateway in the console. 5. Choose Exit. Using VMware High Availability with Storage Gateway API Version 2013-06-30 307 AWS Storage Gateway Tape Gateway User Guide You can ﬁnd information about VMware HA events in the Amazon CloudWatch log groups. For more information, see Getting Tape Gateway Health Logs with CloudWatch Log Groups. Working with Tape Gateway storage resources The topics in this section describe how to manage the storage resources associated with your Tape Gateway, such as the physical disks attached to a gateway's virtual host platform, the Amazon EBS volumes attached to a gateway's Amazon EC2 instance, your virtual tape library devices such as medium changers, and the tapes in your virtual tape libraries. Topics • Removing Disks from Your Gateway - Learn about what to do if you need to remove a disk from the virtual host platform for your gateway, for example if you have a failed disk. • Managing Amazon EBS volumes on Amazon EC2 gateways - Learn about how you can increase or reduce the quanity of Amazon EBS volumes that are allocated for use as upload buﬀer or cache storage for a gateway that is hosted on an Amazon EC2 instance. • Working with VTL Devices - Learn about how to manage your virtual tape library devices, including how to select a medium changer for a Tape Gateway, how to update the device driver for a medium changer, and how to display barcodes for tapes in Microsoft System Center Data Protection Manager. • Managing tapes in your virtual tape library - Learn about how to manage the tapes and virtual tape libraries associated with your Tape Gateway, including how to manually archive tapes and cancel tape archival that is in progress. Removing Disks from Your Gateway Although we don’t recommend removing the underlying disks from your gateway, you might want to remove a disk from your gateway, for
storagegateway-tgw-ug-124	storagegateway-tgw-ug.pdf	124	how to select a medium changer for a Tape Gateway, how to update the device driver for a medium changer, and how to display barcodes for tapes in Microsoft System Center Data Protection Manager. • Managing tapes in your virtual tape library - Learn about how to manage the tapes and virtual tape libraries associated with your Tape Gateway, including how to manually archive tapes and cancel tape archival that is in progress. Removing Disks from Your Gateway Although we don’t recommend removing the underlying disks from your gateway, you might want to remove a disk from your gateway, for example if you have a failed disk. Removing a Disk from a Gateway Hosted on VMware ESXi You can use the following procedure to remove a disk from your gateway hosted on VMware hypervisor. Working with Tape Gateway storage resources API Version 2013-06-30 308 AWS Storage Gateway Tape Gateway User Guide To remove a disk allocated for the upload buﬀer (VMware ESXi) 1. In the vSphere client, open the context (right-click) menu, choose the name of your gateway VM, and then choose Edit Settings. 2. On the Hardware tab of the Virtual Machine Properties dialog box, select the disk allocated as upload buﬀer space, and then choose Remove. Verify that the Virtual Device Node value in the Virtual Machine Properties dialog box has the same value that you noted previously. Doing this helps ensure that you remove the correct disk. 3. Choose an option in the Removal Options panel, and then choose OK to complete the process of removing the disk. Removing a Disk from a Gateway Hosted on Microsoft Hyper-V Using the following procedure, you can remove a disk from your gateway hosted on a Microsoft Hyper-V hypervisor. To remove an underlying disk allocated for the upload buﬀer (Microsoft Hyper-V) 1. 2. In the Microsoft Hyper-V Manager, open the context (right-click) menu, choose the name of your gateway VM, and then choose Settings. In the Hardware list of the Settings dialog box, select the disk to remove, and then choose Remove. The disks you add to a gateway appear under the SCSI Controller entry in the Hardware list. Verify that the Controller and Location value are the same value that you noted previously. Doing this helps ensure that you remove the correct disk. The ﬁrst SCSI controller displayed in the Microsoft Hyper-V Manager is controller 0. 3. Choose OK to apply the change. Removing a Disk from a Gateway Hosted on Linux KVM To detach a disk from your gateway hosted on Linux Kernel-based Virtual Machine (KVM) hypervisor, you can use a virsh command similar to the one following. Removing Disks from Your Gateway API Version 2013-06-30 309 AWS Storage Gateway Tape Gateway User Guide $ virsh detach-disk domain_name /device/path For more details about managing KVM disks, see documentation of your Linux distribution. Managing Amazon EBS volumes on Amazon EC2 gateways When you initially conﬁgured your gateway to run as an Amazon EC2 instance, you allocated Amazon EBS volumes for use as an upload buﬀer and cache storage. Over time, as your applications needs change, you can allocate additional Amazon EBS volumes for this use. You can also reduce the storage you allocated by removing previously allocated Amazon EBS volumes. For more information about Amazon EBS, see Amazon Elastic Block Store (Amazon EBS) in the Amazon EC2 User Guide. Before you add more storage to the gateway, you should review how to size your upload buﬀer and cache storage based on your application needs for a gateway. To do so, see Determining the size of upload buﬀer to allocate and Determining the size of cache storage to allocate. There are quotas on the maximum storage you can allocate as an upload buﬀer and cache storage. You can attach as many Amazon EBS volumes to your instance as you want, but you can only conﬁgure these volumes as upload buﬀer and cache storage space up to these storage quotas. For more information, see AWS Storage Gateway quotas. To add an Amazon EBS volume and conﬁgure it for your gateway 1. Create an Amazon EBS volume. For instructions, see Creating or Restoring an Amazon EBS Volume in the Amazon EC2 User Guide. 2. Attach the Amazon EBS volume to your Amazon EC2 instance. For instructions, see Attaching an Amazon EBS Volume to an Instance in the Amazon EC2 User Guide. 3. Conﬁgure the Amazon EBS volume you added as either an upload buﬀer or cache storage. For instructions, see Managing local disks for your Storage Gateway. There are times you might ﬁnd you don’t need the amount of storage you allocated for the upload buﬀer. EBS Volumes for EC2 Gateways API Version 2013-06-30 310 AWS Storage Gateway Tape Gateway User Guide To remove an Amazon EBS volume Warning These steps apply
storagegateway-tgw-ug-125	storagegateway-tgw-ug.pdf	125	Guide. 2. Attach the Amazon EBS volume to your Amazon EC2 instance. For instructions, see Attaching an Amazon EBS Volume to an Instance in the Amazon EC2 User Guide. 3. Conﬁgure the Amazon EBS volume you added as either an upload buﬀer or cache storage. For instructions, see Managing local disks for your Storage Gateway. There are times you might ﬁnd you don’t need the amount of storage you allocated for the upload buﬀer. EBS Volumes for EC2 Gateways API Version 2013-06-30 310 AWS Storage Gateway Tape Gateway User Guide To remove an Amazon EBS volume Warning These steps apply only for Amazon EBS volumes allocated as upload buﬀer space, not for volumes allocated to cache. If you remove an Amazon EBS volume that is allocated as cache storage from a Tape Gateway, virtual tapes on the gateway will have the IRRECOVERABLE status, and you risk data loss. For more information on the IRRECOVERABLE status, see Understanding Tape Status Information in a VTL. 1. Shut down the gateway by following the approach described in the Shutting Down Your Gateway VM section. 2. Detach the Amazon EBS volume from your Amazon EC2 instance. For instructions, see Detaching an Amazon EBS Volume from an Instance in the Amazon EC2 User Guide. 3. Delete the Amazon EBS volume. For instructions, see Deleting an Amazon EBS Volume in the Amazon EC2 User Guide. 4. Start the gateway by following the approach described in the Shutting Down Your Gateway VM section. Working with VTL Devices When activating your Tape Gateway, you select your backup application from the list and use the appropriate medium changer. If your backup application is not listed, you choose Other and then choose the medium changer that works with backup application. For a list of recommended media changers for supported backup applications, see https://docs.aws.amazon.com/storagegateway/ latest/tgw/Requirements.html#requirements-backup-sw-for-vtl. Your Tape Gateway setup provides the following iSCSI devices, which you select when activating your gateway. Medium changers: • AWS-Gateway-VTL – This device is provided with the gateway. • STK-L700 – This device emulation is provided with the gateway. Tape drives: Working with VTL Devices API Version 2013-06-30 311 AWS Storage Gateway Tape Gateway User Guide • IBM-ULT3580-TD5—This device emulation is provided with the gateway. Topics • Selecting a Medium Changer After Gateway Activation • Updating the Device Driver for Your Medium Changer • Displaying Barcodes for Tapes in Microsoft System Center DPM Selecting a Medium Changer After Gateway Activation After your gateway is activated, you can choose to select a diﬀerent medium changer type. To select a diﬀerent medium changer type after gateway activation 1. Stop any related jobs that are running in your backup software. 2. On the Windows server, open the iSCSI initiator properties window. 3. Choose the Targets tab to display the discovered targets. 4. On the Discovered targets pane, choose the medium changer you want to change, choose Disconnect, and then choose OK. 5. On the Storage Gateway console, choose Gateways from the navigation pane, and then choose the gateway whose medium changer you want to change. 6. Choose the VTL Devices tab, select the medium changer you want to change, and then choose Change Media Changer. 7. In the Change Media Changer Type dialog box that appears, select the media changer you want from the drop-down list box and then choose Save. Updating the Device Driver for Your Medium Changer 1. Open Device Manager on your Windows server, and expand the Medium Changer devices tree. 2. Open the context (right-click) menu for Unknown Medium Changer, and choose Update Driver Software to open the Update Driver Software-unknown Medium Changer window. 3. In the How do you want to search for driver software? section, choose Browse my computer for driver software. 4. Choose Let me pick from a list of device drivers on my computer. Working with VTL Devices API Version 2013-06-30 312 AWS Storage Gateway Note Tape Gateway User Guide We recommend using the Sony TSL-A500C Autoloader driver with the Veeam Backup & Replication 11A and Microsoft System Center Data Protection Manager backup software. This Sony driver has been tested with these types of backup software up to and including Windows Server 2019. 5. 6. In the Select the device driver you want to install for this hardware section, clear the Show compatible hardware check box, choose Sony in the Manufacturer list, choose Sony - TSL- A500C Autoloader in the Model list, and then choose Next. In the warning box that appears, choose Yes. If the driver is successfully installed, close the Update drive software window. Displaying Barcodes for Tapes in Microsoft System Center DPM If you use the media changer driver for Sony TSL-A500C Autoloader, Microsoft System Center Data Protection Manager doesn't automatically display barcodes for virtual tapes created in Storage Gateway. To display barcodes correctly for your tapes, change
storagegateway-tgw-ug-126	storagegateway-tgw-ug.pdf	126	you want to install for this hardware section, clear the Show compatible hardware check box, choose Sony in the Manufacturer list, choose Sony - TSL- A500C Autoloader in the Model list, and then choose Next. In the warning box that appears, choose Yes. If the driver is successfully installed, close the Update drive software window. Displaying Barcodes for Tapes in Microsoft System Center DPM If you use the media changer driver for Sony TSL-A500C Autoloader, Microsoft System Center Data Protection Manager doesn't automatically display barcodes for virtual tapes created in Storage Gateway. To display barcodes correctly for your tapes, change the media changer driver to Sun/ StorageTek Library. To display barcodes 1. 2. 3. Ensure that all backup jobs have completed and that there are no tasks pending or in progress. Eject and move the tapes to oﬄine storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive) and exit the DPM Administrator console. For information about how to eject a tape in DPM, see Archiving a Tape by Using DPM. In Administrative Tools, choose Services and open the context (right-click) menu for DPM Service in the Detail pane, and then choose Properties. 4. On the General tab, ensure that the Startup type is set to Automatic and choose Stop to stop the DPM service. 5. Get the StorageTek drivers from Microsoft Update Catalog on the Microsoft website. Note Take note of the diﬀerent drivers for the diﬀerent sizes. Working with VTL Devices API Version 2013-06-30 313 AWS Storage Gateway Tape Gateway User Guide For Size 18K, choose x86 drivers. For Size 19K, choose x64 drivers. 6. On your Windows server, open Device Manager, and expand the Medium Changer Devices tree. 7. Open the context (right-click) menu for Unknown Medium Changer, and choose Update Driver Software to open the Update Driver Software-unknown Medium Changer window. 8. Browse to the path of the new driver location and install. The driver appears as Sun/ StorageTek Library. The tape drives remain as an IBM ULT3580-TD5 SCSI sequential device. 9. Reboot the DPM server. 10. In the Storage Gateway console, create new tapes. 11. Open the DPM Administrator console, choose Management, then choose Rescan for new tape libraries . You should see the Sun/StorageTek library. 12. Choose the library and choose Inventory. 13. Choose Add Tapes to add the new tapes into DPM. The new tapes should now display their barcodes. Managing tapes in your virtual tape library Storage Gateway provides one virtual tape library (VTL) for each Tape Gateway you activate. Initially, the library contains no tapes, but you can create tapes whenever you need to. Your application can read and write to any tapes available on your Tape Gateway. A tape's status must be AVAILABLE for you to write to the tape. These tapes are backed by Amazon Simple Storage Service (Amazon S3)—that is, when you write to these tapes, the Tape Gateway stores data in Amazon S3. For more information, see Understanding Tape Status Information in a VTL. Topics • Archiving Tapes • Canceling Tape Archival The tape library shows tapes in your Tape Gateway. The library shows the tape barcode, status, and size, amount of the tape used, and the gateway the tape is associated with. Working with Tapes API Version 2013-06-30 314 AWS Storage Gateway Tape Gateway User Guide When you have a large number of tapes in the library, the console supports searching for tapes by barcode, by status, or by both. When you search by barcode, you can ﬁlter by status and gateway. To search by barcode, status, and gateway 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. In the navigation pane, choose Tapes, and then type a value in the search box. The value can be the barcode, status, or gateway. By default, Storage Gateway searches for all virtual tapes. However, you can also ﬁlter your search by status. If you ﬁlter for status, tapes that match your criteria appear in the library in the Storage Gateway console. If you ﬁlter for gateway, tapes that are associated with that gateway appear in the library in the Storage Gateway console. Note By default, Storage Gateway displays all tapes regardless of status. Archiving Tapes You can archive the virtual tapes that are in your Tape Gateway. When you archive a tape, Storage Gateway moves the tape to the archive. To archive a tape, you use your backup software. Tape archival process consists of three stages, seen as the tape statuses IN TRANSIT TO VTS, ARCHIVING, and ARCHIVED: • To archive a tape, use the command provided by your backup application. When the archival process begins the tape status changes to IN TRANSIT TO VTS and the tape is no longer accessible to your backup application. In this stage, your Tape Gateway is uploading data to AWS.
storagegateway-tgw-ug-127	storagegateway-tgw-ug.pdf	127	archive the virtual tapes that are in your Tape Gateway. When you archive a tape, Storage Gateway moves the tape to the archive. To archive a tape, you use your backup software. Tape archival process consists of three stages, seen as the tape statuses IN TRANSIT TO VTS, ARCHIVING, and ARCHIVED: • To archive a tape, use the command provided by your backup application. When the archival process begins the tape status changes to IN TRANSIT TO VTS and the tape is no longer accessible to your backup application. In this stage, your Tape Gateway is uploading data to AWS. If needed, you can cancel the archival in progress. For more information about canceling archival, see Canceling Tape Archival. Working with Tapes API Version 2013-06-30 315 AWS Storage Gateway Note Tape Gateway User Guide The steps for archiving a tape depend on your backup application. For detailed instructions, see the documentation for your backup application. • After the data upload to AWS completes, the tape status changes to ARCHIVING and Storage Gateway begins moving the tape to the archive. You cannot cancel the archival process at this point. • After the tape is moved to the archive, its status changes to ARCHIVED and you can retrieve the tape to any of your gateways. For more information about tape retrieval, see Retrieving Archived Tapes. The steps involved in archiving a tape depend on your backup software. For instructions on how to archive a tape by using Symantec NetBackup software, see Archiving the Tape. Canceling Tape Archival After you start archiving a tape, you might decide you need your tape back. For example, you might want to cancel the archival process, get the tape back because the archival process is taking too long, or read data from the tape. A tape that is being archived goes through three statuses, as shown following: • IN TRANSIT TO VTS: Your Tape Gateway is uploading data to AWS. • ARCHIVING: Data upload is complete and the Tape Gateway is moving the tape to the archive. • ARCHIVED: The tape is moved and the archive and is available for retrieval. You can cancel archival only when the tape's status is IN TRANSIT TO VTS. Depending on factors such as upload bandwidth and the amount of data being uploaded, this status might or might not be visible in the Storage Gateway console. To cancel a tape archival, use the CancelRetrieval action in the API reference. Getting an activation key for your gateway To receive an activation key for your gateway, make a web request to the gateway virtual machine (VM). The VM returns a redirect that contains the activation key, which is passed as one of the Getting Activation Key API Version 2013-06-30 316 AWS Storage Gateway Tape Gateway User Guide parameters for the ActivateGateway API action to specify the conﬁguration of your gateway. For more information, see ActivateGateway in the Storage Gateway API Reference. Note Gateway activation keys expire in 30 minutes if unused. The request that you make to the gateway VM includes the AWS Region where the activation occurs. The URL that's returned by the redirect in the response contains a query string parameter called activationkey. This query string parameter is your activation key. The format of the query string looks like the following: http://gateway_ip_address/? activationRegion=activation_region. The output of this query returns both activation region and key. The URL also includes vpcEndpoint, the VPC Endpoint ID for gateways that connect using the VPC endpoint type. Note The Storage Gateway Hardware Appliance, VM image templates, and Amazon EC2 Amazon Machine Images (AMI) come preconﬁgured with the HTTP services necessary to receive and respond to the web requests described on this page. It's not required or recommended to install any additional services on your gateway. Topics • Linux (curl) • Linux (bash/zsh) • Microsoft Windows PowerShell • Using your local console Linux (curl) The following examples show you how to get an activation key using Linux (curl). Linux (curl) API Version 2013-06-30 317 AWS Storage Gateway Note Tape Gateway User Guide Replace the highlighted variables with actual values for your gateway. Acceptable values are as follows: • gateway_ip_address - The IPv4 address of your gateway, for 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 speciﬁed, 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
storagegateway-tgw-ug-128	storagegateway-tgw-ug.pdf	128	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 speciﬁed, 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 Linux (bash/zsh) API Version 2013-06-30 318 AWS Storage Gateway Tape Gateway User Guide if [[ -z "$ip_address" \|\| -z "$activation_region" \|\| -z "$gateway_type" ]]; then echo "Usage: get-activation-key ip_address activation_region gateway_type" return 1 fi if redirect_url=$(curl -f -s -S -w '%{redirect_url}' "http://$ip_address/? activationRegion=$activation_region&gatewayType=$gateway_type"); then activation_key_param=$(echo "$redirect_url" \| grep -oE 'activationKey=[A-Z0-9-]+') echo "$activation_key_param" \| cut -f2 -d= else return 1 fi } Microsoft Windows PowerShell The following example shows you how to use Microsoft Windows PowerShell to fetch the HTTP response, parse HTTP headers, and get the activation key. function Get-ActivationKey { [CmdletBinding()] Param( [parameter(Mandatory=$true)][string]$IpAddress, [parameter(Mandatory=$true)][string]$ActivationRegion, [parameter(Mandatory=$true)][string]$GatewayType ) PROCESS { $request = Invoke-WebRequest -UseBasicParsing -Uri "http://$IpAddress/? activationRegion=$ActivationRegion&gatewayType=$GatewayType" -MaximumRedirection 0 - ErrorAction SilentlyContinue if ($request) { $activationKeyParam = $request.Headers.Location \| Select-String -Pattern "activationKey=([A-Z0-9-]+)" $activationKeyParam.Matches.Value.Split("=")[1] } } } Using your local console The following example shows you how to use your local console to generate and display an activation key. Microsoft Windows PowerShell API Version 2013-06-30 319 AWS Storage Gateway Tape Gateway User Guide 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. 2. After you log in and see the AWS Appliance Activation - Conﬁguration 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. Connecting iSCSI Initiators When managing your gateway, you work with volumes or virtual tape library (VTL) devices that are exposed as Internet Small Computer System Interface (iSCSI) targets. For Volume Gateways, the iSCSI targets are volumes. For Tape Gateways, the targets are VTL devices. As part of this work, you do such tasks as connecting to those targets, customizing iSCSI settings, connecting from a Red Hat Linux client, and conﬁguring Challenge-Handshake Authentication Protocol (CHAP). Topics • Connecting your VTL devices to a Windows client • Connecting your VTL devices to a Linux client • Customizing iSCSI Settings • Conﬁguring CHAP Authentication for Your iSCSI Targets The iSCSI standard is an Internet Protocol (IP)–based storage networking standard for initiating and managing connections between IP-based storage devices and clients. The following list deﬁnes some of the terms that are used to describe the iSCSI connection and the components involved. iSCSI initiator The client component of an iSCSI network. The initiator sends requests to the iSCSI target. Initiators can be implemented in software or hardware. Storage Gateway only supports software initiators. Connecting iSCSI Initiators API Version 2013-06-30 320 AWS Storage Gateway iSCSI target Tape Gateway User Guide The server component of the iSCSI network that receives and responds to requests from initiators. Each of your volumes is exposed as an iSCSI target. Connect only one iSCSI initiator to each iSCSI target. Microsoft iSCSI initiator The software program on Microsoft Windows computers that allows you to connect a client computer (that is, the computer running the application whose data you want to write to the gateway) to an external iSCSI-based array (that is, the gateway). The connection is made using the host computer's Ethernet network adapter card. The Microsoft iSCSI initiator has been validated with Storage Gateway on Windows Server 2022. The initiator is built into the operating system. Red Hat iSCSI initiator The iscsi-initiator-utils Resource Package Manager (RPM) package provides you with an iSCSI initiator implemented in software for Red Hat Linux. The package includes a server daemon for the iSCSI protocol. Each type of gateway can connect to iSCSI devices, and you can customize those connections, as described following. Connecting your VTL devices to a Windows client A Tape Gateway exposes several tape drives and a media changer, referred to collectively as VTL devices, as iSCSI targets. For more information, see Requirements
storagegateway-tgw-ug-129	storagegateway-tgw-ug.pdf	129	with Storage Gateway on Windows Server 2022. The initiator is built into the operating system. Red Hat iSCSI initiator The iscsi-initiator-utils Resource Package Manager (RPM) package provides you with an iSCSI initiator implemented in software for Red Hat Linux. The package includes a server daemon for the iSCSI protocol. Each type of gateway can connect to iSCSI devices, and you can customize those connections, as described following. Connecting your VTL devices to a Windows client A Tape Gateway exposes several tape drives and a media changer, referred to collectively as VTL devices, as iSCSI targets. For more information, see Requirements for setting up Tape Gateway. Note You connect only one application to each iSCSI target. The following diagram highlights the iSCSI target in the larger picture of the Storage Gateway architecture. For more information on Storage Gateway architecture, see How Tape Gateway works (architecture). Connecting VTL devices to a Windows client API Version 2013-06-30 321 AWS Storage Gateway Tape Gateway User Guide To connect your Windows client to the VTL devices 1. On the Start menu of your Windows client computer, enter iscsicpl.exe in the Search Programs and ﬁles box, locate the iSCSI initiator program, and then run it. Note You must have administrator rights on the client computer to run the iSCSI initiator. 2. 3. 4. If prompted, choose Yes to start the Microsoft iSCSI initiator service. In the iSCSI Initiator Properties dialog box, choose the Discovery tab, and then choose Discover Portal. In the Discover Target Portal dialog box, enter the IP address of your Tape Gateway for IP address or DNS name, and then choose OK. To get the IP address of your gateway, check the Gateway tab on the Storage Gateway console. If you deployed your gateway on an Amazon EC2 instance, you can ﬁnd the public IP or DNS address in the Description tab on the Amazon EC2 console. Connecting VTL devices to a Windows client API Version 2013-06-30 322 AWS Storage Gateway Tape Gateway User Guide Warning For gateways that are deployed on an Amazon EC2 instance, accessing the gateway over a public internet connection is not supported. The Elastic IP address of the Amazon EC2 instance cannot be used as the target address. 5. Choose the Targets tab, and then choose Refresh. All 10 tape drives and the media changer appear in the Discovered targets box. The status for the targets is Inactive. 6. 7. Select the ﬁrst device and choose Connect. You connect the devices one at a time. In the Connect to Target dialog box, choose OK. 8. Repeat steps 6 and 7 for each of the devices to connect all of them, and then choose OK in the iSCSI Initiator Properties dialog box. 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 the driver provider and (if necessary) update the provider and driver on a Windows client 1. On your Windows client, start Device Manager. 2. 3. 4. Expand Tape drives, choose the context (right-click) menu for a tape drive, and choose Properties. In the Driver tab of the Device Properties dialog box, verify that Driver Provider is Microsoft. If Driver Provider is not Microsoft, set the value as follows: a. b. c. d. e. 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. Select LTO Tape drive and choose Next. Choose Close to close the Update Driver Software window, and verify that the Driver Provider value is now set to Microsoft. 5. Repeat steps 4.1 through 4.5 to update all the tape drives. Connecting VTL devices to a Windows client API Version 2013-06-30 323 AWS Storage Gateway Tape Gateway User Guide Connecting your VTL devices to a Linux client When using Red Hat Enterprise Linux (RHEL), you use the iscsi-initiator-utils RPM package to connect to your gateway iSCSI targets (volumes or VTL devices). To connect a Linux client to the iSCSI targets 1. Install the iscsi-initiator-utils RPM package, if it isn't already installed on your client. You can use the following command to install the package. sudo yum install iscsi-initiator-utils 2. Ensure that the iSCSI daemon is running. a. Verify that the iSCSI daemon is running using one of the following commands. For RHEL 8 or 9, use the following command. sudo service iscsid status b. If the status command doesn't return a status of running, start the daemon using one of the following commands. For RHEL 8 or 9, use the following command. You usually don't need to explicitly start the iscsid service. sudo service iscsid
storagegateway-tgw-ug-130	storagegateway-tgw-ug.pdf	130	package, if it isn't already installed on your client. You can use the following command to install the package. sudo yum install iscsi-initiator-utils 2. Ensure that the iSCSI daemon is running. a. Verify that the iSCSI daemon is running using one of the following commands. For RHEL 8 or 9, use the following command. sudo service iscsid status b. If the status command doesn't return a status of running, start the daemon using one of the following commands. For RHEL 8 or 9, use the following command. You usually don't need to explicitly start the iscsid service. sudo service iscsid start 3. To discover the volume or VTL device targets deﬁned for a gateway, use the following discovery command. sudo /sbin/iscsiadm --mode discovery --type sendtargets --portal [GATEWAY_IP]:3260 Substitute your gateway's IP address for the [GATEWAY_IP] variable in the preceding command. You can ﬁnd the gateway IP in the iSCSI Target Info properties of a volume on the Storage Gateway console. The output of the discovery command will look like the following example output. For Volume Gateways: [GATEWAY_IP]:3260, 1 iqn.1997-05.com.amazon:myvolume Connecting VTL devices to a Linux client API Version 2013-06-30 324 AWS Storage Gateway Tape Gateway User Guide For Tape Gateways: iqn.1997-05.com.amazon:[GATEWAY_IP]-tapedrive-01 Your iSCSI qualiﬁed name (IQN) will be diﬀerent than what is shown preceding, because IQN values are unique to an organization. The name of the target is the name that you speciﬁed when you created the volume. You can also ﬁnd this target name in the iSCSI Target Info properties pane when you select a volume on the Storage Gateway console. 4. To connect to a target, use the following command. Note that you need to specify the correct [GATEWAY_IP] and IQN in the connect command. Warning For gateways that are deployed on an Amazon EC2 instance, accessing the gateway over a public internet connection is not supported. The Elastic IP address of the Amazon EC2 instance cannot be used as the target address. sudo /sbin/iscsiadm --mode node --targetname iqn.1997-05.com.amazon:[ISCSI_TARGET_NAME] --portal [GATEWAY_IP]:3260,1 --login 5. To verify that the volume is attached to the client machine (the initiator), use the following command. ls -l /dev/disk/by-path The output of the command will look like the following example output. lrwxrwxrwx. 1 root root 9 Apr 16 19:31 ip-[GATEWAY_IP]:3260-iscsi- iqn.1997-05.com.amazon:myvolume-lun-0 -> ../../sda We highly recommend that after you set up your initiator, you customize your iSCSI settings as discussed in Customizing Your Linux iSCSI Settings. Customizing iSCSI Settings After you set up your initiator, we highly recommend that you customize your iSCSI settings to prevent the initiator from disconnecting from targets. Customizing iSCSI Settings API Version 2013-06-30 325 AWS Storage Gateway Tape Gateway User Guide By increasing the iSCSI timeout values as shown in the following steps, you make your application better at dealing with write operations that take a long time and other transient issues such as network interruptions. Note Before making changes to the registry, you should make a backup copy of the registry. For information on making a backup copy and other best practices to follow when working with the registry, see Registry best practices in the Microsoft TechNet Library. Topics • Customizing Your Windows iSCSI Settings • Customizing Your Linux iSCSI Settings Customizing Your Windows iSCSI Settings For a Tape Gateway setup, connecting to your VTL devices by using a Microsoft iSCSI initiator is a two-step process: 1. Connect your Tape Gateway devices to your Windows client. 2. If you are using a backup application, conﬁgure the application to use the devices. The Getting Started example setup provides instructions for both these steps. It uses the Symantec NetBackup backup application. For more information, see Connecting your VTL devices and Conﬁguring NetBackup Storage Devices. To customize your Windows iSCSI settings 1. Increase the maximum time for which requests are queued. a. Start Registry Editor (Regedit.exe). b. Navigate to the globally unique identiﬁer (GUID) key for the device class that contains iSCSI controller settings, shown following. Customizing iSCSI Settings API Version 2013-06-30 326 AWS Storage Gateway Tape Gateway User Guide Warning Make sure that you are working in the CurrentControlSet subkey and not another control set, such as ControlSet001 or ControlSet002. HKEY_Local_Machine\SYSTEM\CurrentControlSet\Control\Class\{4D36E97B-E325-11CE- BFC1-08002BE10318} c. Find the subkey for the Microsoft iSCSI initiator, shown following as [<Instance Number]. The key is represented by a four-digit number, such as 0000. HKEY_Local_Machine\SYSTEM\CurrentControlSet\Control\Class\{4D36E97B-E325-11CE- BFC1-08002BE10318}\[<Instance Number] Depending on what is installed on your computer, the Microsoft iSCSI initiator might not be the subkey 0000. You can ensure that you have selected the correct subkey by verifying that the string DriverDesc has the value Microsoft iSCSI Initiator. d. To show the iSCSI settings, choose the Parameters subkey. e. Open the context (right-click) menu for the MaxRequestHoldTime DWORD (32-bit) value, choose Modify, and then change the value to 600. MaxRequestHoldTime speciﬁes how many seconds Microsoft iSCSI initiator should
storagegateway-tgw-ug-131	storagegateway-tgw-ug.pdf	131	initiator, shown following as [<Instance Number]. The key is represented by a four-digit number, such as 0000. HKEY_Local_Machine\SYSTEM\CurrentControlSet\Control\Class\{4D36E97B-E325-11CE- BFC1-08002BE10318}\[<Instance Number] Depending on what is installed on your computer, the Microsoft iSCSI initiator might not be the subkey 0000. You can ensure that you have selected the correct subkey by verifying that the string DriverDesc has the value Microsoft iSCSI Initiator. d. To show the iSCSI settings, choose the Parameters subkey. e. Open the context (right-click) menu for the MaxRequestHoldTime DWORD (32-bit) value, choose Modify, and then change the value to 600. MaxRequestHoldTime speciﬁes how many seconds Microsoft iSCSI initiator should hold and retry outstanding commands for, before notifying the upper layer of a Device Removal event. This value represents a hold time of 600 seconds. 2. You can increase the maximum amount of data that can be sent in iSCSI packets by modifying the following parameters: • FirstBurstLength controls the maximum amount of data that can be transmitted in an unsolicited write request. Set this value to 262144 or the Windows OS default, whichever is higher. Customizing iSCSI Settings API Version 2013-06-30 327 AWS Storage Gateway Tape Gateway User Guide • MaxBurstLength is similar to FirstBurstLength, but it sets the maximum amount of data that can be transmitted in solicited write sequences. Set this value to 1048576 or the Windows OS default, whichever is higher. • MaxRecvDataSegmentLength controls the maximum data segment size that is associated with a single protocol data unit (PDU). Set this value to 262144 or the Windows OS default, whichever is higher. Note Diﬀerent backup software can be optimized to work best using diﬀerent iSCSI settings. To verify which values for these parameters will provide the best performance, see the documentation for your backup software. 3. Increase the disk timeout value, as shown following: a. Start Registry Editor (Regedit.exe), if you haven't already. b. Navigate to the Disk subkey in the Services subkey of the CurrentControlSet, shown following. HKEY_Local_Machine\SYSTEM\CurrentControlSet\Services\Disk c. Open the context (right-click) menu for the TimeOutValue DWORD (32-bit) value, choose Modify, and then change the value to 600. TimeOutValue speciﬁes how many seconds iSCSI initiator will wait for a response from the target before it attempts session recovery by dropping and re-establishing the connection. This value represents a timeout period of 600 seconds. 4. To ensure that the new conﬁguration values take eﬀect, restart your system. Before restarting, you must make sure that the results of all write operations to volumes are ﬂushed. To do this, take any mapped storage volume disks oﬄine before restarting. Customizing Your Linux iSCSI Settings After setting up the initiator for your gateway, we highly recommend that you customize your iSCSI settings to prevent the initiator from disconnecting from targets. By increasing the iSCSI timeout Customizing iSCSI Settings API Version 2013-06-30 328 AWS Storage Gateway Tape Gateway User Guide values as shown following, you make your application better at dealing with write operations that take a long time and other transient issues such as network interruptions. Note Commands might be slightly diﬀerent for other types of Linux. The following examples are based on Red Hat Linux. To customize your Linux iSCSI settings 1. Increase the maximum time for which requests are queued. a. Open the /etc/iscsi/iscsid.conf ﬁle and ﬁnd the following lines. node.session.timeo.replacement_timeout = [replacement_timeout_value] node.conn[0].timeo.noop_out_interval = [noop_out_interval_value] node.conn[0].timeo.noop_out_timeout = [noop_out_timeout_value] b. Set the [replacement_timeout_value] value to 600. Set the [noop_out_interval_value] value to 60. Set the [noop_out_timeout_value] value to 600. All three values are in seconds. Note The iscsid.conf settings must be made before discovering the gateway. If you have already discovered your gateway or logged in to the target, or both, you can delete the entry from the discovery database using the following command. Then you can rediscover or log in again to pick up the new conﬁguration. iscsiadm -m discoverydb -t sendtargets -p [GATEWAY_IP]:3260 -o delete 2. Increase the maximum values for the amount of data that can be transmitted in each response. Customizing iSCSI Settings API Version 2013-06-30 329 AWS Storage Gateway Tape Gateway User Guide a. Open the /etc/iscsi/iscsid.conf ﬁle and ﬁnd the following lines. node.session.iscsi.FirstBurstLength = [replacement_first_burst_length_value] node.session.iscsi.MaxBurstLength = [replacement_max_burst_length_value] node.conn[0].iscsi.MaxRecvDataSegmentLength = [replacement_segment_length_value] b. We recommend the following values to achieve better performance. Your backup software might be optimized to use diﬀerent values, so see your backup software documentation for best results. Set the [replacement_first_burst_length_value] value to 262144 or the Linux OS default, whichever is higher. Set the [replacement_max_burst_length_value] value to 1048576 or the Linux OS default, whichever is higher. Set the [replacement_segment_length_value] value to 262144 or the Linux OS default, whichever is higher. Note Diﬀerent backup software can be optimized to work best using diﬀerent iSCSI settings. To verify which values for these parameters will provide the best performance, see the documentation for your backup software. 3. Restart your system to ensure that
storagegateway-tgw-ug-132	storagegateway-tgw-ug.pdf	132	backup software might be optimized to use diﬀerent values, so see your backup software documentation for best results. Set the [replacement_first_burst_length_value] value to 262144 or the Linux OS default, whichever is higher. Set the [replacement_max_burst_length_value] value to 1048576 or the Linux OS default, whichever is higher. Set the [replacement_segment_length_value] value to 262144 or the Linux OS default, whichever is higher. Note Diﬀerent backup software can be optimized to work best using diﬀerent iSCSI settings. To verify which values for these parameters will provide the best performance, see the documentation for your backup software. 3. Restart your system to ensure that the new conﬁguration values take eﬀect. Before restarting, make sure that the results of all write operations to your tapes are ﬂushed. To do this, unmount tapes before restarting. Conﬁguring CHAP Authentication for Your iSCSI Targets Storage Gateway supports authentication between your gateway and iSCSI initiators by using Challenge-Handshake Authentication Protocol (CHAP). CHAP provides protection against playback attacks by periodically verifying the identity of an iSCSI initiator as authenticated to access a volume and VTL device target. Conﬁguring CHAP Authentication API Version 2013-06-30 330 AWS Storage Gateway Note CHAP conﬁguration is optional but highly recommended. Tape Gateway User Guide To set up CHAP, you must conﬁgure it both on the Storage Gateway console and in the iSCSI initiator software that you use to connect to the target. Storage Gateway uses mutual CHAP, which is when the initiator authenticates the target and the target authenticates the initiator. To set up mutual CHAP for your targets 1. Conﬁgure CHAP on the Storage Gateway console, as discussed in To conﬁgure CHAP for a VTL device target on the Storage Gateway console. 2. In your client initiator software, complete the CHAP conﬁguration: • To conﬁgure mutual CHAP on a Windows client, see To conﬁgure mutual CHAP on a Windows client. • To conﬁgure mutual CHAP on a Red Hat Linux client, see To conﬁgure mutual CHAP on a Red Hat Linux client. To conﬁgure CHAP for a VTL device target on the Storage Gateway console In this procedure, you specify two secret keys that are used to read and write to a virtual tape. These same keys are used in the procedure to conﬁgure the client initiator. 1. In the navigation pane, choose Gateways. 2. Choose your gateway, and then choose the VTL Devices tab to display all your VTL devices. 3. Choose the device that you want to conﬁgure CHAP for. 4. Provide the requested information in the Conﬁgure CHAP Authentication dialog box. a. For Initiator Name, enter the name of your iSCSI initiator. This name is an Amazon iSCSI qualiﬁed name (IQN) that is prepended by iqn.1997-05.com.amazon: followed by the target name. The following is an example. iqn.1997-05.com.amazon:your-tape-device-name Conﬁguring CHAP Authentication API Version 2013-06-30 331 AWS Storage Gateway Tape Gateway User Guide You can ﬁnd the initiator name by using your iSCSI initiator software. For example, for Windows clients, the name is the value on the Conﬁguration tab of the iSCSI initiator. For more information, see To conﬁgure mutual CHAP on a Windows client. Note To change an initiator name, you must ﬁrst deactivate CHAP, change the initiator name in your iSCSI initiator software, and then activate CHAP with the new name. b. For Secret used to Authenticate Initiator, enter the secret requested. This secret must be a minimum of 12 characters and a maximum of 16 characters long. This value is the secret key that the initiator (that is, the Windows client) must know to participate in CHAP with the target. c. For Secret used to Authenticate Target (Mutual CHAP), enter the secret requested. This secret must be a minimum of 12 characters and a maximum of 16 characters long. This value is the secret key that the target must know to participate in CHAP with the initiator. Note The secret used to authenticate the target must be diﬀerent than the secret to authenticate the initiator. d. Choose Save. 5. On the VTL Devices tab, conﬁrm that the iSCSI CHAP authentication ﬁeld is set to true. To conﬁgure mutual CHAP on a Windows client In this procedure, you conﬁgure CHAP in the Microsoft iSCSI initiator using the same keys that you used to conﬁgure CHAP for the volume on the console. 1. If the iSCSI initiator is not already started, on the Start menu of your Windows client computer, choose Run, enter iscsicpl.exe, and then choose OK to run the program. 2. Conﬁgure mutual CHAP conﬁguration for the initiator (that is, the Windows client): a. Choose the Conﬁguration tab. Conﬁguring CHAP Authentication API Version 2013-06-30 332 AWS Storage Gateway Tape Gateway User Guide Note The Initiator Name value is unique to your initiator and company. The name shown preceding is the value that you used in the Conﬁgure CHAP Authentication dialog
storagegateway-tgw-ug-133	storagegateway-tgw-ug.pdf	133	used to conﬁgure CHAP for the volume on the console. 1. If the iSCSI initiator is not already started, on the Start menu of your Windows client computer, choose Run, enter iscsicpl.exe, and then choose OK to run the program. 2. Conﬁgure mutual CHAP conﬁguration for the initiator (that is, the Windows client): a. Choose the Conﬁguration tab. Conﬁguring CHAP Authentication API Version 2013-06-30 332 AWS Storage Gateway Tape Gateway User Guide Note The Initiator Name value is unique to your initiator and company. The name shown preceding is the value that you used in the Conﬁgure CHAP Authentication dialog box of the Storage Gateway console. The name shown in the example image is for demonstration purposes only. b. Choose CHAP. c. In the iSCSI Initiator Mutual Chap Secret dialog box, enter the mutual CHAP secret value. In this dialog box, you enter the secret that the initiator (the Windows client) uses to authenticate the target (the storage volume). This secret allows the target to read and write to the initiator. This secret is the same as the secret entered into the Secret used to Authenticate Target (Mutual CHAP) box in the Conﬁgure CHAP Authentication dialog box. For more information, see Conﬁguring CHAP Authentication for Your iSCSI Targets. d. If the key that you entered is fewer than 12 characters or more than 16 characters long, an Initiator CHAP secret error dialog box appears. Choose OK, and then enter the key again. 3. Conﬁgure the target with the initiator's secret to complete the mutual CHAP conﬁguration. a. b. c. d. e. Choose the Targets tab. If the target that you want to conﬁgure for CHAP is currently connected, disconnect the target by selecting it and choosing Disconnect. Select the target that you want to conﬁgure for CHAP, and then choose Connect. In the Connect to Target dialog box, choose Advanced. In the Advanced Settings dialog box, conﬁgure CHAP. i. ii. Select Activate CHAP log on. Enter the secret that is required to authenticate the initiator. This secret is the same as the secret entered into the Secret used to Authenticate Initiator box in the Conﬁgure CHAP Authentication dialog box. For more information, see Conﬁguring CHAP Authentication for Your iSCSI Targets. iii. Select Perform mutual authentication. Conﬁguring CHAP Authentication API Version 2013-06-30 333 AWS Storage Gateway Tape Gateway User Guide iv. To apply the changes, choose OK. f. In the Connect to Target dialog box, choose OK. 4. If you provided the correct secret key, the target shows a status of Connected. To conﬁgure mutual CHAP on a Red Hat Linux client In this procedure, you conﬁgure CHAP in the Linux iSCSI initiator using the same keys that you used to conﬁgure CHAP for the volume on the Storage Gateway console. 1. Ensure that the iSCSI daemon is running and that you have already connected to a target. If you have not completed these two tasks, see Connecting to a Linux Client. 2. Disconnect and remove any existing conﬁguration for the target for which you are about to conﬁgure CHAP. a. To ﬁnd the target name and ensure it is a deﬁned conﬁguration, list the saved conﬁgurations using the following command. sudo /sbin/iscsiadm --mode node b. Disconnect from the target. The following command disconnects from the target named myvolume that is deﬁned in the Amazon iSCSI qualiﬁed name (IQN). Change the target name and IQN as required for your situation. sudo /sbin/iscsiadm --mode node --logout GATEWAY_IP:3260,1 iqn.1997-05.com.amazon:myvolume c. Remove the conﬁguration for the target. The following command removes the conﬁguration for the myvolume target. sudo /sbin/iscsiadm --mode node --op delete --targetname iqn.1997-05.com.amazon:myvolume 3. Edit the iSCSI conﬁguration ﬁle to activate CHAP. a. Get the name of the initiator (that is, the client you are using). Conﬁguring CHAP Authentication API Version 2013-06-30 334 AWS Storage Gateway Tape Gateway User Guide The following command gets the initiator name from the /etc/iscsi/ initiatorname.iscsi ﬁle. sudo cat /etc/iscsi/initiatorname.iscsi The output from this command looks like this: InitiatorName=iqn.1994-05.com.redhat:8e89b27b5b8 b. Open the /etc/iscsi/iscsid.conf ﬁle. c. Uncomment the following lines in the ﬁle and specify the correct values for username, password, username_in, and password_in. node.session.auth.authmethod = CHAP node.session.auth.username = username node.session.auth.password = password node.session.auth.username_in = username_in node.session.auth.password_in = password_in For guidance on what values to specify, see the following table. Conﬁguration Setting username Value The initiator name that you found in a previous step in this procedure. The value starts with iqn. For example, iqn.1994- is a valid username value 05.com.redhat:8e89b27b5b8 . password The secret key used to authenticate the initiator (the client you are using) when it communicates with the volume. username_in The IQN of the target volume. The value starts with iqn and ends with the target name. For example, iqn.1997- is a valid username_in 05.com.amazon:myvolume value. Conﬁguring CHAP Authentication API Version 2013-06-30 335 AWS Storage
storagegateway-tgw-ug-134	storagegateway-tgw-ug.pdf	134	password_in For guidance on what values to specify, see the following table. Conﬁguration Setting username Value The initiator name that you found in a previous step in this procedure. The value starts with iqn. For example, iqn.1994- is a valid username value 05.com.redhat:8e89b27b5b8 . password The secret key used to authenticate the initiator (the client you are using) when it communicates with the volume. username_in The IQN of the target volume. The value starts with iqn and ends with the target name. For example, iqn.1997- is a valid username_in 05.com.amazon:myvolume value. Conﬁguring CHAP Authentication API Version 2013-06-30 335 AWS Storage Gateway Tape Gateway User Guide Conﬁguration Setting password_in Value The secret key used to authenticate the target (the volume) when it communicates to the initiator. d. Save the changes in the conﬁguration ﬁle, and then close the ﬁle. 4. Discover and log in to the target. To do so, follow the steps in Connecting to a Linux Client. 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 traﬃc 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 diﬀerent 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 conﬁgure your on-premises router accordingly. Even with Direct Connect, VPC endpoints must be created with the HAProxy. For more information, see Creating a Virtual Interface in the AWS Direct Connect User Guide. Using AWS Direct Connect with Storage Gateway API Version 2013-06-30 336 AWS Storage Gateway Tape Gateway User Guide For details about AWS Direct Connect, see What is AWS Direct Connect? in the AWS Direct Connect User Guide. 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 ﬁnd how to get your gateway's IP address, see one of the following: • 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 Logging In to Your Amazon EC2 Gateway Local Console. 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/. Getting the gateway IP address API Version 2013-06-30 337 AWS Storage Gateway Tape Gateway User Guide 2. In the navigation pane, choose Instances, and then select the EC2 instance that your gateway is deployed on. 3.
storagegateway-tgw-ug-135	storagegateway-tgw-ug.pdf	135	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/. Getting the gateway IP address API Version 2013-06-30 337 AWS Storage Gateway Tape Gateway User Guide 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. 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 conﬁgure 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 include: volume, virtual tape, iSCSI target, and vtl device. These 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 the following table. Understanding Resources and Resource IDs API Version 2013-06-30 338 AWS Storage Gateway Tape Gateway User Guide Resource Type Gateway ARN ARN Format arn:aws:storagegateway: region:account-id :gateway/ gateway- id Tape ARN arn:aws:storagegateway: region:account-id :tape/tapebarcode Target ARN ( iSCSI target) VTL Device ARN arn:aws:storagegateway: region:account-id :gateway/ gateway- id /target/iSCSItarget arn:aws:storagegateway: region:account-id :gateway/ gateway- id /device/vtldevice Storage Gateway also supports the use of EC2 instances and EBS volumes and snapshots. These resources are Amazon EC2 resources that are used in Storage Gateway. 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 identiﬁer, 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 identiﬁer for gateways. A volume ID takes the form vol-3344CCDD where vol is the resource identiﬁer for volumes. For virtual tapes, you can prepend a up to a four character preﬁx to the barcode ID to help you organize your tapes. 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. Working with Resource IDs API Version 2013-06-30 339 AWS Storage Gateway Tape Gateway User Guide 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 deﬁne. You can add tags to gateways, volumes, and virtual tapes. You can search and ﬁlter 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 ﬁlter 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
storagegateway-tgw-ug-136	storagegateway-tgw-ug.pdf	136	can add tags to gateways, volumes, and virtual tapes. You can search and ﬁlter 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 ﬁlter 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. 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 preﬁx 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. Tagging Your Resources API Version 2013-06-30 340 AWS Storage Gateway Tape Gateway User Guide 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. 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 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 Tags API Version 2013-06-30 341 AWS Storage Gateway Tape Gateway User Guide Working with open-source components for Storage Gateway This section describes third party tools and licenses that we depend on to deliver Storage Gateway functionality. The source code for certain open-source software components that are included with the AWS Storage Gateway software is available for download at the following locations: • For gateways deployed on VMware ESXi, download sources.tar • For gateways deployed on Microsoft Hyper-V, download sources_hyperv.tar • For gateways deployed on Linux Kernel-based Virtual Machine (KVM), download 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. AWS Storage Gateway quotas In this topic, you can ﬁnd information about volume and tape quotas, conﬁguration, and performance limits for Storage Gateway. Topics • Quotas for tapes • Recommended local disk sizes for your gateway Quotas for tapes The following table lists quotas for tapes. Description Tape Gateway Minimum size of a virtual tape Maximum size of a virtual tape 100 GiB 15 TiB Open-Source Components API Version 2013-06-30 342 AWS Storage Gateway Description Tape Gateway User Guide Tape Gateway Maximum number of virtual tapes assigned to a gateway 1,500 Total size of all tapes assigned to a gateway 1 PiB Maximum number of virtual tapes in archive No limit Total size of all tapes in archive No limit 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) Upload Buﬀer Upload Buﬀer Other Required (Minimum) (Maximum) Local Disks Tape gateway 150 GiB 64 TiB 150 GiB 2 TiB — Note You can conﬁgure one or more local drives
storagegateway-tgw-ug-137	storagegateway-tgw-ug.pdf	137	Gateway User Guide Tape Gateway Maximum number of virtual tapes assigned to a gateway 1,500 Total size of all tapes assigned to a gateway 1 PiB Maximum number of virtual tapes in archive No limit Total size of all tapes in archive No limit 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) Upload Buﬀer Upload Buﬀer Other Required (Minimum) (Maximum) Local Disks Tape gateway 150 GiB 64 TiB 150 GiB 2 TiB — Note You can conﬁgure one or more local drives for your cache and upload buﬀer, up to the maximum capacity. When adding cache or upload buﬀer 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 buﬀer. Recommended local disk sizes for your gateway API Version 2013-06-30 343 AWS Storage Gateway Tape Gateway User Guide API Reference for Storage Gateway In addition to using the console, you can use the AWS Storage Gateway API to programmatically conﬁgure 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 AWS Storage Gateway. The AWS SDKs for Java, .NET, and PHP wrap the underlying AWS Storage Gateway API, simplifying your programming tasks. For information about downloading the SDK libraries, see Sample Code Libraries. Topics • Storage Gateway Required Request Headers • Signing Requests • Error Responses • Actions Storage Gateway Required Request Headers This section describes the required headers that you must send with every POST request to 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 Required Request Headers API Version 2013-06-30 344 AWS Storage Gateway Tape Gateway User Guide Host: storagegateway.us-east-2.amazonaws.com Content-Type: application/x-amz-json-1.1 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 Storage Gateway. Headers shown below that begin with "x-amz" are AWS-speciﬁc 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 allows 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 Storage Gateway. as the content type for all Content-Type: application/x-amz-json-1.1 Required Request Headers API Version 2013-06-30 345 AWS Storage Gateway Tape Gateway User Guide Header Host x-amz-date Description Use the host header to specify the Storage Gateway endpoint where you send your request. For example, storagegateway.us- east-2.amazonaws.com region. For more information about the endpoints available for Storage is the endpoint for the US East (Ohio) Gateway, see AWS Storage Gateway Endpoints and Quotas in 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 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 speciﬁes 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. Required Request Headers API Version 2013-06-30 346 AWS Storage Gateway Signing Requests Tape Gateway User Guide Storage Gateway requires that you authenticate every request you
storagegateway-tgw-ug-138	storagegateway-tgw-ug.pdf	138	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 speciﬁes 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. Required Request Headers API Version 2013-06-30 346 AWS Storage Gateway Signing Requests Tape Gateway User Guide 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 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. Other Signing Requests API Version 2013-06-30 347 AWS Storage Gateway Tape Gateway User Guide reference calculations are included in the Signature Version 4 Test Suite of the Amazon Web Services Glossary. 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. 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 Example Signature Calculation API Version 2013-06-30 348 AWS Storage Gateway 20120910T000000Z 20120910/us-east-2/storagegateway/aws4_request 92c0effa6f9224ac752ca179a04cecbede3038b0959666a8160ab452c9e51b3e Tape Gateway User Guide The ﬁrst 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: derived key = HMAC(HMAC(HMAC(HMAC("AWS4" + YourSecretAccessKey,"20120910"),"us- east-2"),"storagegateway"),"aws4_request") If the secret access key, wJalrXUtnFEMI/K7MDENG/bPxRﬁCYEXAMPLEKEY, is used, then the calculated signature is: 6d4c40b8f2257534dbdca9f326f147a0a7a419b63aff349d9d9c737c9a0f4c81 The ﬁnal 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 Error Responses API Version 2013-06-30 349 AWS Storage Gateway Tape Gateway User Guide InvalidSignatureException is returned by any API response if there is a problem with the request signature. However, the operation error code ActivationKeyInvalid
storagegateway-tgw-ug-139	storagegateway-tgw-ug.pdf	139	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 Error Responses API Version 2013-06-30 349 AWS Storage Gateway Tape Gateway User Guide 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. Exceptions 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 speciﬁc operation error code. Exception Message HTTP Status Code IncompleteSignatur The speciﬁed 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 not valid. 400 Bad Request InvalidClientTokenId The X.509 certiﬁcate or AWS Access Key ID provided does not exist in our records. 403 Forbidden InvalidGatewayRequ estException One of the operation error code messages in Operation Error Codes. 400 Bad Request InvalidSignatureEx ception Exceptions The request signature we calculate d does not match the signature you 400 Bad Request API Version 2013-06-30 350 AWS Storage Gateway Tape Gateway User Guide Exception Message HTTP Status Code provided. Check your AWS Access Key and signing method. MissingAction The request is missing an action or operation parameter. 400 Bad Request MissingAuthenticat ionToken The request must contain either a valid (registered) AWS Access Key ID 403 Forbidden RequestExpired or X.509 certiﬁcate. 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. 400 Bad Request SerializationException An error occurred during serializa tion. Check that your JSON payload 400 Bad Request is well-formed. 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 speciﬁed . Valid operations are listed in Operations in Storage Gateway. 429 Too Many Requests 400 Bad Request UnrecognizedClient Exception The security token included in the request is not valid. 400 Bad Request Exceptions API Version 2013-06-30 351 AWS Storage Gateway Exception Message ValidationException The value of an input parameter is bad or out of range. Tape Gateway User Guide HTTP Status Code 400 Bad Request 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 speciﬁed activatio n key has expired. ActivateGateway ActivationKeyInvalid The speciﬁed activatio n key is not valid. ActivateGateway ActivationKeyNotFound The speciﬁed activatio n key was not found. ActivateGateway BandwidthThrottleS cheduleNotFound The speciﬁed bandwidth throttle was not found. DeleteBandwidthRateLimit CannotExportSnapshot The speciﬁed snapshot cannot be exported. CreateCachediSCSIVolume CreateStorediSCSIVolume InitiatorNotFound The speciﬁed initiator was not found. DeleteChapCredentials DiskAlreadyAllocated The speciﬁed disk is already allocated. AddCache AddUploadBuﬀer Operation Error Codes API Version 2013-06-30 352 AWS Storage Gateway Tape Gateway User Guide Operation Error Code Message Operations That Return this Error Code AddWorkingStorage CreateStorediSCSIVolume DiskDoesNotExist The speciﬁed disk does not exist. AddCache AddUploadBuﬀer AddWorkingStorage CreateStorediSCSIVolume CreateStorediSCSIVolume CreateStorediSCSIVolume CreateStorediSCSIVolume ActivateGateway DiskSizeNotGigAligned DiskSizeGreaterTha nVolumeMaxSize DiskSizeLessThanVo lumeSize DuplicateCertifica teInfo The speciﬁed disk is not gigabyte-aligned. The speciﬁed disk size is greater than the maximum volume size. The speciﬁed disk size is less than the volume size. The speciﬁed certiﬁca te information is a duplicate. Operation Error Codes API Version 2013-06-30 353 AWS Storage Gateway Tape Gateway User Guide Operation Error Code Message Operations That Return this Error Code GatewayInternalError A gateway internal error occurred. AddCache AddUploadBuﬀer 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 354 AWS Storage Gateway Tape Gateway User Guide Operation Error Code Message Operations That Return this Error Code ListVolumes ListVolumeRecoveryPoints
storagegateway-tgw-ug-140	storagegateway-tgw-ug.pdf	140	than the maximum volume size. The speciﬁed disk size is less than the volume size. The speciﬁed certiﬁca te information is a duplicate. Operation Error Codes API Version 2013-06-30 353 AWS Storage Gateway Tape Gateway User Guide Operation Error Code Message Operations That Return this Error Code GatewayInternalError A gateway internal error occurred. AddCache AddUploadBuﬀer 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 354 AWS Storage Gateway Tape 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 355 AWS Storage Gateway Tape Gateway User Guide Operation Error Code Message Operations That Return this Error Code GatewayNotConnected The speciﬁed gateway is not connected. AddCache AddUploadBuﬀer 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 356 AWS Storage Gateway Tape 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 357 AWS Storage Gateway Tape Gateway User Guide Operation Error Code Message Operations That Return this Error Code GatewayNotFound The speciﬁed gateway was not found. AddCache AddUploadBuﬀer 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 358 AWS Storage Gateway Tape 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 359 AWS Storage Gateway Tape Gateway User Guide Operation Error Code Message Operations That Return this Error Code GatewayProxyNetwor kConnectionBusy The speciﬁed gateway proxy network connection is busy. AddCache AddUploadBuﬀer 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 360 AWS Storage Gateway Tape 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 361 AWS Storage Gateway Tape Gateway User Guide Operation Error Code Message Operations That Return this Error Code InternalError An internal error occurred. ActivateGateway AddCache AddUploadBuﬀer 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 362 AWS Storage Gateway Tape 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 363 AWS Storage Gateway Tape Gateway User Guide Operation Error Code Message Operations That Return this Error Code InvalidParameters The speciﬁed request contains incorrect parameters. ActivateGateway AddCache AddUploadBuﬀer 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 364 AWS Storage Gateway Tape 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 AddUploadBuﬀer AddWorkingStorage LunInvalid The speciﬁed LUN is incorrect. CreateStorediSCSIVolume Operation Error Codes API Version 2013-06-30 365 AWS Storage Gateway Tape 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 conﬁguration has changed. CreateCachediSCSIVolume CreateStorediSCSIVolume Operation Error Codes API Version 2013-06-30 366 AWS Storage Gateway Tape Gateway User Guide Operation Error Code Message Operations That Return this Error Code NotSupported The speciﬁed operation is not supported. ActivateGateway AddCache AddUploadBuﬀer 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 367 AWS Storage Gateway Tape 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 speciﬁed gateway is out of date. ActivateGateway SnapshotInProgress Exception The speciﬁed snapshot is in progress. DeleteVolume SnapshotIdInvalid The speciﬁed snapshot is not valid. CreateCachediSCSIVolume CreateStorediSCSIVolume StagingAreaFull The staging area is full. CreateCachediSCSIVolume CreateStorediSCSIVolume Operation Error Codes API Version 2013-06-30 368 AWS Storage Gateway Tape Gateway User Guide Operation Error Code Message Operations That Return this Error Code TargetAlreadyExists TargetInvalid The speciﬁed target already exists. CreateCachediSCSIVolume CreateStorediSCSIVolume The speciﬁed target is not valid. CreateCachediSCSIVolume CreateStorediSCSIVolume DeleteChapCredentials DescribeChapCredentials UpdateChapCredentials TargetNotFound The speciﬁed target was not found. CreateCachediSCSIVolume CreateStorediSCSIVolume DeleteChapCredentials DescribeChapCredentials DeleteVolume UpdateChapCredentials Operation Error Codes API Version 2013-06-30 369 AWS Storage Gateway Tape Gateway User
storagegateway-tgw-ug-141	storagegateway-tgw-ug.pdf	141	out of date. ActivateGateway SnapshotInProgress Exception The speciﬁed snapshot is in progress. DeleteVolume SnapshotIdInvalid The speciﬁed snapshot is not valid. CreateCachediSCSIVolume CreateStorediSCSIVolume StagingAreaFull The staging area is full. CreateCachediSCSIVolume CreateStorediSCSIVolume Operation Error Codes API Version 2013-06-30 368 AWS Storage Gateway Tape Gateway User Guide Operation Error Code Message Operations That Return this Error Code TargetAlreadyExists TargetInvalid The speciﬁed target already exists. CreateCachediSCSIVolume CreateStorediSCSIVolume The speciﬁed target is not valid. CreateCachediSCSIVolume CreateStorediSCSIVolume DeleteChapCredentials DescribeChapCredentials UpdateChapCredentials TargetNotFound The speciﬁed target was not found. CreateCachediSCSIVolume CreateStorediSCSIVolume DeleteChapCredentials DescribeChapCredentials DeleteVolume UpdateChapCredentials Operation Error Codes API Version 2013-06-30 369 AWS Storage Gateway Tape Gateway User Guide Operation Error Code Message UnsupportedOperati onForGatewayType The speciﬁed 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 DescribeUploadBuﬀer DescribeWorkingStorage ListVolumeRecoveryPoints VolumeAlreadyExists The speciﬁed volume already exists. CreateCachediSCSIVolume CreateStorediSCSIVolume VolumeIdInvalid VolumeInUse The speciﬁed volume is not valid. DeleteVolume The speciﬁed volume is already in use. DeleteVolume Operation Error Codes API Version 2013-06-30 370 AWS Storage Gateway Tape Gateway User Guide Operation Error Code Message Operations That Return this Error Code VolumeNotFound The speciﬁed volume was not found. CreateSnapshot CreateSnapshotFromVolumeRec overyPoint DeleteVolume DescribeCachediSCSIVolumes DescribeSnapshotSchedule DescribeStorediSCSIVolumes UpdateSnapshotSchedule VolumeNotReady The speciﬁed 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 371 AWS Storage Gateway Tape Gateway User Guide "errorDetails": "String" } } The following table explains the JSON error response ﬁelds shown in the preceding syntax. __type One of the exceptions from Exceptions. Type: String error Contains API-speciﬁc error details. In general errors (i.e., not speciﬁc to any API), this error information is not shown. Type: Collection errorCode One of the operation error codes . Type: String errorDetails This ﬁeld 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 372 AWS Storage Gateway Tape 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." } Operations in Storage Gateway For a list of Storage Gateway operations, see Actions in the AWS Storage Gateway API Reference. Operations API Version 2013-06-30 373 AWS Storage Gateway Tape Gateway User Guide Document history for the Tape Gateway User Guide • API version: 2013-06-30 • Latest documentation update: November 24, 2020 The following table describes important changes in each release of the AWS Storage Gateway User Guide after April 2018. For notiﬁcation 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 cust omers 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 option to turn maintenance updates on or oﬀ Storage Gateway receives regular maintenance updates that can include operating June 6, 2024 system and software API Version 2013-06-30 374 AWS Storage Gateway Tape Gateway User Guide upgrades, ﬁxes to address stability, performance, and security, and access to new features. You can now conﬁgure a setting to turn these updates on or oﬀ for each individual gateway in your deployment. For more information, see Managing gateway updates using the AWS Storage Gateway console. Deprecated support for Tape Gateway on Snowball Edge It is no longer possible to host Tape Gateway on Snowball March 14, 2024 Edge devices. Updated instructions for testing your gateway setup The instructions for testing your gateway setup using using 3rd party applications 3rd party applications October 24, 2023 now describe the expected behavior if
storagegateway-tgw-ug-142	storagegateway-tgw-ug.pdf	142	ﬁxes to address stability, performance, and security, and access to new features. You can now conﬁgure a setting to turn these updates on or oﬀ for each individual gateway in your deployment. For more information, see Managing gateway updates using the AWS Storage Gateway console. Deprecated support for Tape Gateway on Snowball Edge It is no longer possible to host Tape Gateway on Snowball March 14, 2024 Edge devices. Updated instructions for testing your gateway setup The instructions for testing your gateway setup using using 3rd party applications 3rd party applications October 24, 2023 now describe the expected behavior if your gateway restarts during an ongoing backup job. For more information, see Using Your Backup Software to Test Your Gateway Setup. API Version 2013-06-30 375 AWS Storage Gateway Tape Gateway User Guide Updated recommended CloudWatch alarms The CloudWatch HealthNot October 2, 2023 alarm now ifications applies to and is recommende d for all gateway types and host platforms. Recommend ed conﬁguration settings have also been updated for HealthNotifications and AvailabilityNotifi cations . For more information see Understan ding CloudWatch alarms. Increased maximum tape size to 15 TiB for Tape Gateways For Tape Gateways, the maximum size of a virtual October 4, 2022 tape is now increased from 5 TiB to 15 TiB. For more information, see Quotas for Tapes in the Storage Gateway User Guide.. Separated Tape and Volume Gateway User Guides The Storage Gateway User Guide, which previously March 23, 2022 contained information about both the tape and Volume Gateway types, has been split into the Tape Gateway User Guide and the Volume Gateway User Guide, each containing information on only one type of gateway. For more information, see Tape Gateway User Guide and Volume Gateway User Guide. API Version 2013-06-30 376 AWS Storage Gateway Tape Gateway User Guide Updated gateway creation procedures New Tapes interface January 18, 2022 September 23, 2021 Procedures for creating all gateway types using the Storage Gateway console have been updated. For more information, see Creating Your Gateway. The Tape overview page in the AWS Storage Gateway console has been updated with new search and ﬁltering features. All relevant procedures in this guide have been updated to describe the new functionality. For more information, see Managing Your Tape Gateway. Support for Quest NetVault Backup 13 for Tape Gateway Tape Gateways now support Quest NetVault Backup 13 August 22, 2021 running on Microsoft Win dows Server 2012 R2 or Microsoft Windows Server 2016. For more information, see, see Testing Your Setup by Using Quest NetVault Backup. To help make the user guides for Tape Gateway and Volume Gateway easier to follow for customers setting up their respective gateway types, some unnecessary topics have been removed. July 21, 2021 S3 File Gateway topics removed from Tape and Volume Gateway guides API Version 2013-06-30 377 AWS Storage Gateway Tape Gateway User Guide Support for IBM Spectrum Protect 8.1.10 on Windows Tape Gateways now support IBM Spectrum Protect version and Linux for Tape Gateway 8.1.10 running on Microsoft November 24, 2020 FedRAMP compliance Schedule-based bandwidth throttling Windows Server and Linux. For more information, see Testing Your Setup by Using IBM Spectrum Protect. Storage Gateway is now FedRAMP compliant. For more information, see Compliance validation for Storage Gateway. Storage Gateway now supports schedule-based bandwidth throttling for tape and Volume Gateways. For more information, see Scheduling bandwidth throttling using the Storage Gateway console. November 24, 2020 November 9, 2020 Cached volume and Tape Gateways local cache storage Storage Gateway now supports a local cache of November 9, 2020 4x increase up to 64 TB for cached volume and Tape Gateways, 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. API Version 2013-06-30 378 AWS Storage Gateway Gateway migration Tape Gateway User Guide September 10, 2020 Storage Gateway now supports migrating cached Volume Gateways to new virtual machines. For more information, see Moving Cached Volumes to a New Cached Volume Gateway Virtual Machine. Support for tape retention lock and write-once-read-ma Storage Gateway supports tape retention lock on virtual August 19, 2020 ny (WORM) tape protection tapes and write once read many (WORM). Tape retention lock lets you specify the retention mode and period on archived virtual tapes, preventing them from being deleted for a ﬁxed amount of time up to 100 years. It includes permission controls on who can delete tapes or modify retention settings. For more information, see Using Tape Retention Lock. WORM- activated virtual tapes help ensure that data on active tapes in your virtual tape library cannot be overwritten or erased. For more informati on, see Write Once, Read Many (WORM) Tape Protectio n. API Version 2013-06-30 379 AWS Storage Gateway Tape Gateway User Guide Order the hardware appliance through the console You
storagegateway-tgw-ug-143	storagegateway-tgw-ug.pdf	143	you specify the retention mode and period on archived virtual tapes, preventing them from being deleted for a ﬁxed amount of time up to 100 years. It includes permission controls on who can delete tapes or modify retention settings. For more information, see Using Tape Retention Lock. WORM- activated virtual tapes help ensure that data on active tapes in your virtual tape library cannot be overwritten or erased. For more informati on, see Write Once, Read Many (WORM) Tape Protectio n. API Version 2013-06-30 379 AWS Storage Gateway Tape Gateway User Guide 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 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 Gateway migration 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. Storage Gateway now supports migrating tape and stored Volume Gateways to new virtual machines. For more information, see Moving Your Data to a New Gateway. July 31, 2020 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. API Version 2013-06-30 380 AWS Storage Gateway Tape Gateway User Guide 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 Volume Gateway, see Choosing a service endpoint. To choose a FIPS endpoint for a Tape Gateway, see Connect your Tape Gateway to AWS. 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 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-eﬀe 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. API Version 2013-06-30 381 AWS Storage Gateway Tape Gateway User Guide Tape Gateway write and read performance 2x increase Storage Gateway increases performance for reading from April 23, 2020 and writing to virtual tapes on Tape Gateway by 2x, allowing you to perform faster backup and recovery than before. For more information, see Performance Guidance for Tape Gateways in the Storage Gateway User Guide. Support for automatic tape creation Storage Gateway now provides the ability to April 23, 2020 automatically create new virtual tapes. Tape Gateway automatically creates new virtual tapes to maintain the minimum number of available tapes you conﬁgure and then makes these new tapes available for import by the backup application, allowing your backup jobs to run without interruption. For more information, see Creating Tapes Automatically in the Storage Gateway 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 API Version 2013-06-30 382 New AWS Region AWS Storage Gateway Tape 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 383 AWS Storage Gateway Tape Gateway User Guide New AWS Region for Tape Gateway Tape Gateway is now available in the South September 24, 2019 America (Sao Paulo) Region. For more information, see AWS Storage Gateway Endpoints and Quotas in the AWS General Reference. Support for IBM Spectrum Protect version 7.1.9 on Linux, Tape Gateways now support IBM Spectrum Protect (Tivoli and for Tape Gateways an
storagegateway-tgw-ug-144	storagegateway-tgw-ug.pdf	144	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 383 AWS Storage Gateway Tape Gateway User Guide New AWS Region for Tape Gateway Tape Gateway is now available in the South September 24, 2019 America (Sao Paulo) Region. For more information, see AWS Storage Gateway Endpoints and Quotas in the AWS General Reference. Support for IBM Spectrum Protect version 7.1.9 on Linux, Tape Gateways now support IBM Spectrum Protect (Tivoli and for Tape Gateways an Storage Manager) vers increased maximum tape size ion 7.1.9 running on Linux, September 10, 2019 to 5 TiB in addition to running on Microsoft Windows. For more information, see Testing Your Setup by Using IBM Spectrum Protect in the Storage Gateway User Guide.. Also, for Tape Gateways, the maximum size of a virtual tape is now increased from 2.5 TiB to 5 TiB. For more information, see Quotas for Tapes in the Storage Gateway User Guide.. API Version 2013-06-30 384 AWS Storage Gateway Support for Amazon CloudWatch Logs New AWS Region New AWS Region Tape Gateway User Guide September 4, 2019 August 14, 2019 July 29, 2019 You can now conﬁgure File Gateways with Amazon CloudWatch Log Groups to get notiﬁed about errors and the health of your gateway and its resources. For more information, see Getting Noti ﬁed About Gateway Health and Errors With Amazon CloudWatch Log Groups in the Storage Gateway User Guide. Storage Gateway is now available in the Asia Paciﬁc (Hong Kong) Region. For more information, see AWS Storage Gateway Endpoints 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 Endpoints and Quotas in the AWS General Reference. API Version 2013-06-30 385 AWS Storage Gateway Tape 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. Support for moving virtual tapes from S3 Glacier Flexible You can now move your virtual tapes that are archived May 28, 2019 Retrieval to S3 Glacier Deep in the S3 Glacier Flexible Archive Retrieval storage class to the S3 Glacier Deep Archive stora ge class for cost eﬀective and long-term data retention . For more information, see Moving a Tape from S3 Glacier Flexible Retrieval to S3 Glacier Deep Archive. SMB ﬁle 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) ﬁle shares. For more information, see Using Microsoft Windows ACLs to Control Access to an SMB File Share. API Version 2013-06-30 386 AWS Storage Gateway Tape Gateway User Guide Integration with S3 Glacier Deep Archive Tape Gateway integrates with S3 Glacier Deep Archive. You March 27, 2019 can now archive virtual tapes in S3 Glacier Deep Archive for long-term data retentio n. For more information, see Archiving Virtual Tapes. Availability of Storage Gateway Hardware Appliance The Storage Gateway Hardware Appliance is now February 25, 2019 in Europe Integration with AWS Backup 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 Storage Gateway Hardware Appliance from 5 TB to 12 TB and replace the installed copper network card with a 10 Gigabit ﬁber optic network card. For more information, see Setting Up Your Hardware Appliance. Storage Gateway integrate s with AWS Backup. You can now use AWS Backup to back up on-premises business applications that use Storage Gateway volumes for cloud- backed storage. For more information, see Backing Up Your Volumes. January 16, 2019 API Version 2013-06-30 387 AWS Storage Gateway Tape Gateway User Guide Support for Bacula Enterprise and IBM Spectrum Protect Tape Gateways now support Bacula Enterprise and IBM November 13, 2018 Spectrum Protect. Storage Gateway also now supports newer versions of Veritas NetBackup, Veritas Backu p Exec and Quest NetVault backup. You can now use these backup applications to back up your data to Amazon S3 and archive directly to oﬄine storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Using Your Backup Software to Test Your Gateway Setup. Support for Storage Gateway Hardware Appliance The 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 ﬁle, tape, and
storagegateway-tgw-ug-145	storagegateway-tgw-ug.pdf	145	Gateway also now supports newer versions of Veritas NetBackup, Veritas Backu p Exec and Quest NetVault backup. You can now use these backup applications to back up your data to Amazon S3 and archive directly to oﬄine storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Using Your Backup Software to Test Your Gateway Setup. Support for Storage Gateway Hardware Appliance The 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 ﬁle, tape, and Volume Gateways. For more information, see Using the Storage Gateway Hard ware Appliance. API Version 2013-06-30 388 AWS Storage Gateway Tape Gateway User Guide Compatibility with Microsoft System Center 2016 Data Tape Gateways are now compatible with Microsoft Protection Manager (DPM) System Center 2016 Data July 18, 2018 Protection Manager (DPM). You can now use Microsoft DPM to back up your data to Amazon S3 and archive directly to oﬄine storage (S3 Glacier Flexible Retrieval or S 3 Glacier Deep Archive). For more information, see Testing Your Setup by Using Microsoft System Center Data Protectio n Manager. Support for Server Message Block (SMB) protocol File Gateways added support for the Server Message Block June 20, 2018 (SMB) protocol to file shares. For more information, see Creating a File Share. Support for ﬁle share, cached volumes, and virtual tape You can now use AWS Key Management Service encryption (AWS KMS) to encrypt data June 12, 2018 written to a ﬁle share, cached volume, or virtual tape. Currently, you can do this by using the AWS Storage Gateway API. For more information, see Data encryption using AWS KMS. API Version 2013-06-30 389 AWS Storage Gateway Tape Gateway User Guide Support for NovaStor DataCenter/Network Tape Gateways now support NovaStor DataCenter/ May 24, 2018 Network. You can now use NovaStor DataCente r/Network version 6.4 or 7.1 to back up your data to Amazon S3 and archive directly to oﬄine storage (S3 Glacier Flexible Retrieval or S 3 Glacier Deep Archive). For more information, see Testing Your Setup by Using NovaSt or DataCenter/Network. Earlier updates The following table describes important changes in each release of the AWS Storage Gateway User 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 ﬁle storage class shares. Using this storage class, you can store your object data in a single Availability Zone in Amazon S3. For more information, see Create a ﬁle share. New Region Tape Gateway is now available in the Asia Paciﬁc (Singapore) Region. For detailed information, see AWS Regions that support Storage Gateway. Support for refresh cache notiﬁcation, requester pays, With File Gateways, you can now be notiﬁed when the gateway ﬁnishes refreshing the cache for your Amazon S3 bucket. For more information, see RefreshCache.html in the Storage Gateway API Refer and canned ACL ence. Date Changed April 4, 2018 April 3, 2018 March 1, 2018 Earlier updates API Version 2013-06-30 390 AWS Storage Gateway Change Description Tape Gateway User Guide Date Changed s for Amazon S3 File Gateways now allow the requester or reader buckets. instead of the bucket owner to pay for access charges. File Gateways now allow you to give full control to the owner of the S3 bucket that maps to the NFS ﬁle share. For more information, see Create a ﬁle share. Support for Dell EMC NetWorker V9.x Tape Gateways now support Dell EMC NetWorker V9.x. You can now use Dell EMC NetWorker V9.x to back up your data to Amazon S3 and archive directly February 27, 2018 to oﬄine storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Your Setup by Using Dell EMC NetWorker. New Region Storage Gateway is now available in the Europe (Paris) Region. For detailed information, see AWS December 18, 2017 Regions that support Storage Gateway. Support for ﬁle upload notiﬁcat File Gateways can now notify you when all ﬁles written to your NFS ﬁle share have been uploaded November 21, 2017 ion and guessing to Amazon S3. For more information, see NotifyWhe of the MIME type nUploaded in the Storage Gateway API Reference. File Gateways now allow guessing of the MIME type for uploaded objects based on ﬁle extensions. For more information, see Create a ﬁle share. Support for VMware ESXi Hypervisor version 6.5 AWS Storage Gateway now supports VMware ESXi Hypervisor version 6.5. This is in addition to version 4.1, 5.0, 5.1, 5.5, and 6.0. For more information, see Supported hypervisors and host requirements. September 13, 2017 Earlier updates API Version 2013-06-30 391 AWS Storage Gateway Change Description Tape Gateway User Guide Date Changed Compatibility with Commvault 11 Tape
storagegateway-tgw-ug-146	storagegateway-tgw-ug.pdf	146	see NotifyWhe of the MIME type nUploaded in the Storage Gateway API Reference. File Gateways now allow guessing of the MIME type for uploaded objects based on ﬁle extensions. For more information, see Create a ﬁle share. Support for VMware ESXi Hypervisor version 6.5 AWS Storage Gateway now supports VMware ESXi Hypervisor version 6.5. This is in addition to version 4.1, 5.0, 5.1, 5.5, and 6.0. For more information, see Supported hypervisors and host requirements. September 13, 2017 Earlier updates API Version 2013-06-30 391 AWS Storage Gateway Change Description Tape Gateway User Guide Date Changed Compatibility with Commvault 11 Tape Gateways are now compatible with Commvault 11. You can now use Commvault to back up your September 12, 2017 data to Amazon S3 and archive directly to oﬄine storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Y our Setup by Using Commvault. 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 Support for three to ﬁve hour tape For a Tape Gateway, you can now retrieve your tapes from archive in three to ﬁve hours. You can also May 23, 2017 retrieval from determine the amount of data written to your tape archive from your backup application or your virtual tape library (VTL). For more information, see Viewing Tape Usage. New Region Storage Gateway is now available in the Asia Paciﬁc (Mumbai) Region. For detailed information, see AWS May 02, 2017 Regions that support Storage Gateway. Updates to ﬁle share settings File Gateways now add mount options to the ﬁle share settings. You can now set squash and read- March 28, 2017 Support for cache refresh for ﬁle shares only options for your ﬁle share. For more informati on, see Create a ﬁle share. File Gateways now can ﬁnd 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 392 AWS Storage Gateway Tape Gateway User Guide Change Description Support for cloning a volume For cached Volume Gateways, AWS Storage Gateway now supports the ability to clone a volume from an existing volume. For more information, see Cloning a Volume. Date Changed March 16, 2017 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 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 or Create and activate an Amazon FSx File Gateway. For information about how to launch a File Gateway AMI, see Deploying an S3 File Gateway on an Amazon EC2 host or Deploying FSx File Gateway on an Amazon EC2 host. Compatibility with Arcserve 17 Tape Gateway is now compatible with Arcserve 17. You can now use Arcserve to back up your data to January 17, 2017 Amazon S3 and archive directly to S3 Glacier Flexible Retrieval. For more information, see Testing Your Setup by Using Arcserve Backup r17.0. New Region New Region Storage Gateway is now available in the EU (London) Region. For detailed information, see AWS Regions that support Storage Gateway. December 13, 2016 Storage Gateway is now available in the Canada (Central) Region. For detailed information, see AWS Regions that support Storage Gateway. December 08, 2016 Earlier updates API Version 2013-06-30 393 AWS Storage Gateway Change Description Tape Gateway User Guide Date Changed Support for File Gateway In addition to Volume Gateways and Tape Gateway, Storage Gateway now provides File Gateway. File November 29, 2016 Gateway combines a service and virtual software appliance, allowing you to store and retrieve objects in Amazon S3 using industry-standard ﬁle protocols such as Network File System (NFS). The gateway provides access to objects in Amazon S3 as ﬁles on an NFS mount point. Backup Exec 16 Tape Gateway is now compatible with Backup Exec 16. You can now use Backup Exec 16 to back up your November 7, 2016 data to Amazon S3 and archive directly to oﬄine storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Y our Setup by Using Veritas Backup Exec. Compatibility with Micro Focus (HPE) Tape Gateway is now compatible with Micro Focus (HPE) Data Protector 9.x. You can now use HPE Data November 2, 2016 Data Protector 9.x Protector to back up your data to Amazon S3 and archive directly to S3 Glacier Flexible Retrieval. For more
storagegateway-tgw-ug-147	storagegateway-tgw-ug.pdf	147	now compatible with Backup Exec 16. You can now use Backup Exec 16 to back up your November 7, 2016 data to Amazon S3 and archive directly to oﬄine storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Y our Setup by Using Veritas Backup Exec. Compatibility with Micro Focus (HPE) Tape Gateway is now compatible with Micro Focus (HPE) Data Protector 9.x. You can now use HPE Data November 2, 2016 Data Protector 9.x Protector to back up your data to Amazon S3 and archive directly to S3 Glacier Flexible Retrieval. For more information, see Testing Your Setup by Using Micro Focus (HPE) Data Protector. New Region Storage Gateway is now available in the US East (Ohio) Region. For detailed information, see AWS Regions that support Storage Gateway. October 17, 2016 Storage Gateway console redesign August 30, 2016 The Storage Gateway Management Console has been redesigned to make it easier to conﬁgure, manage, and monitor your gateways, volumes, and virtual tapes. The user interface now provides views that can be ﬁltered and provides direct links to integrated AWS services such as CloudWatch and Amazon EBS. For more information, see Sign Up for AWS Storage Gateway. Earlier updates API Version 2013-06-30 394 AWS Storage Gateway Tape Gateway User Guide Change Description Compatibility with Veeam Backup Tape Gateway is now compatible with Veeam Backup & Replication V9 Update 2 or later (that is, version & Replication V9 9.0.0.1715 or later). You can now use Veeam Backup Update 2 or later Replication V9 Update 2 or later to back up your Date Changed August 15, 2016 data to Amazon S3 and archive directly to oﬄine storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Your Setup by Using Veeam Backup & Replication. Longer volume and snapshot IDs Storage Gateway is introducing longer IDs for volumes and snapshots. You can activate the longer April 25, 2016 ID format for your volumes, snapshots, and other supported AWS resources. For more information, see Understanding Storage Gateway Resources and Resource IDs. New Region Support for storage up to 512 Tape Gateway is now available in the Asia Paciﬁc (Seoul) Region. For more information, see AWS Regions that support Storage Gateway. March 21, 2016 TiB in size for For stored volumes, you can now create up to 32 stored volumes storage volumes up to 16 TiB in size each, for a maximum of 512 TiB of storage. For more informati on, see Stored volumes architecture and AWS Storage Gateway quotas. Other gateway updates and enhancements to the Storage Total size of all tapes in a virtual tape library is Gateway local increased to 1 PiB. For more information, see AWS console Storage Gateway quotas. You can now set the password for your VM local console on the Storage Gateway Console. For information, see Setting the Local Console Password from the Storage Gateway Console. Earlier updates API Version 2013-06-30 395 Tape Gateway User Guide Date Changed February 29, 2016 October 20, 2015 AWS Storage Gateway Change Description Compatibility with for Dell EMC Tape Gateway is now compatible with Dell EMC NetWorker 8.x. You can now use Dell EMC NetWorker NetWorker 8.x to back up your data to Amazon S3 and archiv e directly to oﬄine storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Your Setup by Using Dell EMC NetWorker. Support for VMware ESXi AWS Storage Gateway now supports the VMware ESXi Hypervisor version 6.0 and the Red Hat Hypervisor version Enterprise Linux 7 iSCSI initiator. For more infor 6.0 and Red Hat Enterprise Linux 7 mation, see Supported hypervisors and host requirements and Supported iSCSI initiators. iSCSI initiator Content restructu re This release includes this improvement: The documentation now includes a Managing Your Activated Gateway section that combines m anagement tasks that are common to all gateway solutions. Following, you can ﬁnd instructions on how you can manage your gateway after you have deployed and activated it. For more information, see Managing your Tape Gateway. Earlier updates API Version 2013-06-30 396 AWS Storage Gateway Change Description Tape Gateway User Guide Date Changed Support for storage up to For cached volumes, you can now create up to 32 storage volumes at up to 32 TiB each for a maximum September 16, 2015 1,024 TiB in size of 1,024 TiB of storage. For more information, see for cached vol Cached volumes architecture and AWS Storage umes Gateway quotas. Support for the VMXNET3 (10 GbE) network adapter type in If your gateway is hosted on a VMware ESXi hypervisor, you can reconfigure the gateway to use the VMXNET3 adapter type. For more information, see Conﬁguring network adapters for your gateway. VMware ESXi The maximum upload rate for Storage Gateway has hypervisor
storagegateway-tgw-ug-148	storagegateway-tgw-ug.pdf	148	cached volumes, you can now create up to 32 storage volumes at up to 32 TiB each for a maximum September 16, 2015 1,024 TiB in size of 1,024 TiB of storage. For more information, see for cached vol Cached volumes architecture and AWS Storage umes Gateway quotas. Support for the VMXNET3 (10 GbE) network adapter type in If your gateway is hosted on a VMware ESXi hypervisor, you can reconfigure the gateway to use the VMXNET3 adapter type. For more information, see Conﬁguring network adapters for your gateway. VMware ESXi The maximum upload rate for Storage Gateway has hypervisor increased to 120 MB a second, and the maximum download rate has increased to 20 MB a second. Performance enhancements The Storage Gateway local console has been updated and enhanced with additional features to help you perform maintenance tasks. For more information, Miscellaneous see Conﬁguring Your Gateway Network. enhancements and updates to the Storage Gateway local console Support for tagging Storage Gateway now supports resource tagging. You can now add tags to gateways, volumes, and virtual tapes to make them easier to manage. For more information, see Tagging Storage Gateway Resources. September 2, 2015 Earlier updates API Version 2013-06-30 397 AWS Storage Gateway Tape Gateway User Guide Change Description Compatibility with Quest (formerly Tape Gateway is now compatible with Quest NetVault Backup 10.0. You can now use Quest Dell) NetVault NetVault Backup 10.0 to back up your data to Backup 10.0 Amazon S3 and archive directly to oﬄine storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Your Setup by Using Quest NetVault Backup. Date Changed June 22, 2015 Earlier updates API Version 2013-06-30 398 AWS Storage Gateway Tape Gateway User Guide Change Description Support for 16 TiB storage Storage Gateway now supports 16 TiB storage volumes for stored volumes gateway setups. You volumes for can now create 12 16 TiB storage volumes for a stored volumes maximum of 192 TiB of storage. For more informati gateway setups on, see Stored volumes architecture. Date Changed June 3, 2015 Support for You can now determine whether your system system resource resources (virtual CPU cores, root volume size, and checks on the RAM) are suﬃcient for your gateway to function Storage Gateway properly. For more information, see Viewing your local console gateway system resource status or Viewing your gateway system resource status. Support for the Red Hat Enterpris Storage Gateway now supports the Red Hat Enterpris e Linux 6 iSCSI e Linux 6 iSCSI initiator. For more information, see initiator Requirements for setting up Tape Gateway. This release includes the following Storage Gateway improvements and updates: • • From the Storage Gateway console, you can now see the date and time the last successful software update was applied to your gateway. For more information, see Managing gateway updates. Storage Gateway now provides an API you can use to list iSCSI initiators connected to your storage volumes. For more information, see ListVolum eInitiators in the API reference. Earlier updates API Version 2013-06-30 399 AWS Storage Gateway Tape Gateway User Guide Change Description Support for Microsoft Hyper- Storage Gateway now supports Microsoft Hyper- V hypervisor versions 2012 and 2012 R2. This is V hypervisor in addition to support for Microsoft Hyper-V hy versions 2012 and pervisor version 2008 R2. For more information, see 2012 R2 Supported hypervisors and host requirements. Date Changed April 30, 2015 Compatibility with Symantec Backup Tape Gateway is now compatible with Symantec Backup Exec 15. You can now use Symantec Backup April 6, 2015 Exec 15 Exec 15 to back up your data to Amazon S3 and archive directly to oﬄine storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Your Setup by Using Veritas Backup Exec. CHAP authentic ation support for Storage Gateway now supports conﬁguring CHAP authentication for storage volumes. For more April 2, 2015 storage volumes information, see Conﬁgure CHAP authentication for your volumes. Support for VMware ESXi Storage Gateway now supports VMware ESXi Hypervisor versions 5.1 and 5.5. This is in addition March 30, 2015 Hypervisor version to support for VMware ESXi Hypervisor versions 5.1 and 5.5 4.1 and 5.0. For more information, see Supported hypervisors and host requirements. Support for Windows CHKDSK utility Storage Gateway now supports the Windows CHKDSK utility. You can use this utility to verify the integrity of your volumes and ﬁx errors on the volumes. For more information, see Troubleshooting volume issues. March 04, 2015 Earlier updates API Version 2013-06-30 400 AWS Storage Gateway Change Description Tape Gateway User Guide Date Changed Integration with AWS CloudTrail to Storage Gateway is now integrated with AWS CloudTrail. AWS CloudTrail captures API calls made December 16, 2014 capture API calls by or on behalf of Storage Gateway in your Amazon Web Services
storagegateway-tgw-ug-149	storagegateway-tgw-ug.pdf	149	Supported hypervisors and host requirements. Support for Windows CHKDSK utility Storage Gateway now supports the Windows CHKDSK utility. You can use this utility to verify the integrity of your volumes and ﬁx errors on the volumes. For more information, see Troubleshooting volume issues. March 04, 2015 Earlier updates API Version 2013-06-30 400 AWS Storage Gateway Change Description Tape Gateway User Guide Date Changed Integration with AWS CloudTrail to Storage Gateway is now integrated with AWS CloudTrail. AWS CloudTrail captures API calls made December 16, 2014 capture API calls by or on behalf of Storage Gateway in your Amazon Web Services account and delivers the log ﬁles to an Amazon S3 bucket that you specify. For more information, see Logging and Monitoring in AWS Storage Gateway. This release includes the following Storage Gateway improvement and update: • Virtual tapes that have dirty data in cache storage (that is, that contain content that has not been uploaded to AWS) are now recovered when a gateway's cached drive changes. For more information, see Recovering a Virtual Tape From An Unrecoverable Gateway. Earlier updates API Version 2013-06-30 401 AWS Storage Gateway Change Description Tape Gateway User Guide Date Changed Compatibility with additional backup software and medium cha nger Tape Gateway is now compatible with the following backup software: November 3, 2014 • • • • Symantec Backup Exec 2014 Microsoft System Center 2012 R2 Data Protection Manager Veeam Backup & Replication V7 Veeam Backup & Replication V8 You can now use these four backup software products with the Storage Gateway virtual tape library (VTL) to back up to Amazon S3 and archive directly to oﬄine storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Using Your Backup Software to Test Your Gateway Setup. Storage Gateway now provides an additional medium changer that works with the new backup software. This release includes miscellaneous AWS Storage Gateway improvements and updates. Europe (Frankfurt) Region Storage Gateway is now available in the Europe (Frankfurt) Region. For detailed information, see AWS Regions that support Storage Gateway. October 23, 2014 Earlier updates API Version 2013-06-30 402 AWS Storage Gateway Tape Gateway User Guide Change Description Content restructu re Created a Getting Started section that is common to all gateway solutions. Following, you can ﬁnd Date Changed May 19, 2014 instructions for you to download, deploy, and activate a gateway. After you deploy and activate a gateway, you can proceed to further instructions speciﬁc to stored volumes, cached volumes, and Tape Gateway setups. For more information, see Creating a Tape Gateway. Compatibility with Symantec Backup Tape Gateway is now compatible with Symantec Backup Exec 2012. You can now use Symantec April 28, 2014 Exec 2012 Backup Exec 2012 to back up your data to Amazon S3 and archive directly to oﬄine storage (S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive). For more information, see Testing Your Setup by Using Veritas Backup Exec. Earlier updates API Version 2013-06-30 403 Tape Gateway User Guide Date Changed January 31, 2014 AWS Storage Gateway Change Description Support for Windows Server Failover Clustering Support for VMware ESX initiator Support for performing conﬁguration tasks on Storage Gateway local console • • • Storage Gateway now supports connecting multiple hosts to the same volume if the hosts coordinate access by using Windows Server Failover Clustering (WSFC). However, you can't co nnect multiple hosts to that same volume without using WSFC. Storage Gateway now allows you to manage storage connectivity directly through your ESX host. This provides an alternative to using initiator s resident in the guest OS of your VMs. Storage Gateway now provides support for performing conﬁguration tasks in the Storage Gateway local console. For information about performing conﬁguration tasks on gateways deployed on-premises, see Performing Tasks on the VM Local Console or Performing Tasks on the VM Local Console. For information about performing conﬁguration tasks on gateways deployed on an EC2 instance, see Performing Tasks on the Amazon EC2 Local Console or Performing Tasks on the Amazon EC2 Local Console. Earlier updates API Version 2013-06-30 404 AWS Storage Gateway Change Description Tape Gateway User Guide Date Changed Support for virtual tape library (VTL) Storage Gateway connects an on-premises software appliance with cloud-based storage to integrate your November 5, 2013 on-premises IT environment with the AWS storage and introduction infrastructure. In addition to Volume Gateways of API version (cached volumes and stored volumes), Storage 2013-06-30 Gateway now supports gateway–virtual tape library (VTL). You can conﬁgure Tape Gateway with up to 10 virtual tape drives per gateway. Each virtual tape drive responds to the SCSI command set, so your existing on-premises backup applications will work without modiﬁcation. For more information, see the following topics in the AWS Storage Gateway User Guide. • • For an architectural overview, see How Tape Gateway works
storagegateway-tgw-ug-150	storagegateway-tgw-ug.pdf	150	with cloud-based storage to integrate your November 5, 2013 on-premises IT environment with the AWS storage and introduction infrastructure. In addition to Volume Gateways of API version (cached volumes and stored volumes), Storage 2013-06-30 Gateway now supports gateway–virtual tape library (VTL). You can conﬁgure Tape Gateway with up to 10 virtual tape drives per gateway. Each virtual tape drive responds to the SCSI command set, so your existing on-premises backup applications will work without modiﬁcation. For more information, see the following topics in the AWS Storage Gateway User Guide. • • For an architectural overview, see How Tape Gateway works (architecture). To get started with Tape Gateway, see Creating a Tape Gateway. Support for Microsoft Hyper-V Storage Gateway now provides the ability to deploy an on-premises gateway on the Microsoft Hyper- April 10, 2013 V virtualization platform. Gateways deployed on Microsoft Hyper-V have all the same functionality and features as the existing on-premises Storage Gateway. To get started deploying a gateway with Microsoft Hyper-V, see Supported hypervisors and host requirements. Earlier updates API Version 2013-06-30 405 AWS Storage Gateway Change Description Support for deploying a gateway on Amazon EC2 Storage Gateway now provides the ability to deploy a gateway in Amazon Elastic Compute Cloud (Amazon EC2). You can launch a gateway instance in Amazon EC2 using the Storage Gateway AMI available in AWS Marketplace. To get started deploying a gateway using the Storage Gateway AMI, see Deploy a customized Amazon EC2 instance for Tape Gateway. Tape Gateway User Guide Date Changed January 15, 2013 Earlier updates API Version 2013-06-30 406 AWS Storage Gateway Change Description Support for cached volumes In this release, Storage Gateway introduces support for cached volumes. Cached volumes minimize the and introduction need to scale your on-premises storage infrastruct of API Version 20 ure, while still providing your applications with 12-06-30 low-latency access to their active data. You can Tape Gateway User Guide Date Changed October 29, 2012 create storage volumes up to 32 TiB in size and mount them as iSCSI devices from your on-premis es application servers. Data written to your cached volumes is stored in Amazon Simple Storage Service (Amazon S3), with only a cache of recently written and recently read data stored locally on your on- premises storage hardware. Cached volumes allow you to utilize Amazon S3 for data where higher retrieval latencies are acceptable, such as for older, infrequently accessed data, while maintaining storage on-premises for data where low-latency access is required. In this release, Storage Gateway also introduces a new API version that, in addition to supporting the current operations, provides new operations to support cached volumes. For more information on the two Storage Gateway solutions, see How Tape Gateway works. You can also try a test setup. For instructions, see Creating a Tape Gateway. Earlier updates API Version 2013-06-30 407 AWS Storage Gateway Tape Gateway User Guide Change Description API and IAM support In this release, Storage Gateway introduces API support as well as support for AWS Identity and Access Management(IAM). Date Changed May 9, 2012 • • API support—You can now programmatically conﬁgure and manage your Storage Gateway resources. For more information about the API, see API Reference for Storage Gateway in the AWS Storage Gateway User Guide. IAM support – AWS Identity and Access Management (IAM) lets you create users and manage user access to your Storage Gateway resources by means of IAM policies. For examples of IAM policies, see Identity and Access Management for AWS Storage Gateway. For more information about IAM, see AWS Identity and Access Management (IAM) detail page. Static IP support You can now specify a static IP for your local gateway. For more information, see Conﬁguring Your March 5, 2012 Gateway Network. New guide This is the ﬁrst release of AWS Storage Gateway User Guide. January 24, 2012 Earlier updates API Version 2013-06-30 408 AWS Storage Gateway Tape Gateway User Guide Release notes for Tape Gateway appliance software These release notes describe the new and updated features, improvements, and ﬁxes that are included with each version of the Tape Gateway appliance. Each software version is identiﬁed 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 ﬁeld of the API response. Note A gateway won't report software version information under the following circumstances: • The gateway is oﬄine. • The gateway is running older software that doesn't support version reporting. • The gateway type is FSx File Gateway. For more information about Tape Gateway updates, including how to modify the default automatic maintenance and update schedule for
storagegateway-tgw-ug-151	storagegateway-tgw-ug.pdf	151	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 ﬁeld of the API response. Note A gateway won't report software version information under the following circumstances: • The gateway is oﬄine. • The gateway is running older software that doesn't support version reporting. • The gateway type is FSx File Gateway. For more information about Tape 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-05-01 2.12.8 2025-04-01 2.12.7 • Updated operating system and software elements to improve security and performance for new and existing gateways • Updated operating system and software elements API Version 2013-06-30 409 AWS Storage Gateway Tape Gateway User Guide Release Date Software Version Release Notes 2025-03-04 2.12.6 2025-02-04 2.12.5 2025-01-07 2.12.3 2024-12-06 2.12.2 to improve security and performance for new and existing gateways • Updated operating system and software elements to improve security and performance for new and existing gateways • Updated operating system and software elements to improve security and performance for new and existing gateways • Addressed an issue where gateways could get stuck in shutdown state after a software update • Updated operating system and software elements to improve security and performance for new and existing gateways • Updated operating system and software elements to improve security and performance for new and existing gateways API Version 2013-06-30 410 AWS Storage Gateway Tape Gateway User Guide Release Date Software Version Release Notes 2024-11-06 2.12.1 2024-10-03 2.12.0 2024-08-30 2.11.0 2024-07-29 2.10.0 2024-06-17 2.9.2 • Updated operating system and software elements to improve security and performance for new and existing gateways • Updated operating system and software elements to improve security and performance for new and existing gateways • Updated operating system and software elements to improve security and performance for new and existing gateways • Updated operating system and software elements to improve security and performance for new and existing gateways • Miscellaneous bug ﬁxes and enhancements • Updated operating system and software elements to improve security and performance for new and existing gateways API Version 2013-06-30 411 AWS Storage Gateway Tape Gateway User Guide Release Date Software Version Release Notes 2024-05-28 2.9.0 • Reduced gateway restart time during software updates • Reduced the amount of data transferred for estimating network bandwidth 2024-05-08 2.8.3 • Addressed cloud connectiv 2024-04-10 2.8.1 ity issue when using SOCKS5 proxy • Addressed upload performance degradati on issue under certain conditions (such as a high number of tape erasure operations) • Addressed a memory usage issue introduced in 2.8.0 • Security patch updates • Improved software update process • Addressed missing Network Time Protocol (NTP) component for new gateways API Version 2013-06-30 412 AWS Storage Gateway Tape Gateway User Guide Release Date Software Version Release Notes 2024-03-06 2.8.0 2023-12-19 2.7.0 2023-12-14 2.6.6 2023-10-19 2.6.5 • Updated operating system and software elements to improve security and performance for new gateways • Security patch updates • Improved performance for concurrent Backup and Restore workloads • Updated operating system and software elements to improve security and performance for new gateways • Fixed an issue with relative positioning on larger than 5TiB tapes • Added safeguards against tape overwrites by clients after a gateway restart API Version 2013-06-30 413
storagegateway-vgw-ug-001	storagegateway-vgw-ug.pdf	1	Volume Gateway User Guide AWS Storage Gateway API Version 2013-06-30 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS Storage Gateway Volume Gateway User Guide AWS Storage Gateway: Volume Gateway User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. 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 aﬃliated with, connected to, or sponsored by Amazon. AWS Storage Gateway Table of Contents Volume Gateway User Guide What is Volume Gateway? .............................................................................................................. 1 How Volume Gateway works ..................................................................................................................... 2 Volume Gateways .................................................................................................................................... 2 Getting started with AWS Storage Gateway .................................................................................. 7 Sign Up for AWS Storage Gateway .......................................................................................................... 7 Create an IAM user with administrator privileges ................................................................................. 8 Accessing AWS Storage Gateway .............................................................................................................. 9 AWS Regions that support Storage Gateway ....................................................................................... 10 Volume Gateway setup requirements .......................................................................................... 11 Hardware and storage requirements ..................................................................................................... 11 Hardware requirements for VMs ....................................................................................................... 11 Requirements for Amazon EC2 instance types ............................................................................... 11 .................................................................................................................................................................. 12 Storage requirements .......................................................................................................................... 12 Network and ﬁrewall requirements ....................................................................................................... 13 Port requirements ................................................................................................................................. 14 Networking and ﬁrewall requirements for the hardware appliance ........................................... 25 Allowing gateway access through ﬁrewall and routers ................................................................ 27 Conﬁguring security group ................................................................................................................. 29 Supported hypervisors and host requirements ................................................................................... 30 Supported iSCSI initiators ........................................................................................................................ 31 Using the hardware appliance ...................................................................................................... 32 Setting up your hardware appliance ...................................................................................................... 33 Physically installing your hardware appliance ..................................................................................... 34 Accessing the hardware appliance console ........................................................................................... 36 Conﬁguring hardware appliance network parameters ....................................................................... 38 Activating your hardware appliance ....................................................................................................... 39 Creating a gateway on your hardware appliance ................................................................................ 41 Conﬁguring 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 Set up gateway ..................................................................................................................................... 47 API Version 2013-06-30 iii AWS Storage Gateway Volume Gateway User Guide Connect to AWS .................................................................................................................................... 47 Review and activate ............................................................................................................................. 48 Overview - Gateway Conﬁguration ........................................................................................................ 48 Overview - Storage Resources ................................................................................................................ 48 Creating a Volume Gateway .................................................................................................................... 48 Set up a Volume Gateway .................................................................................................................. 49 Connect your Volume Gateway to AWS ........................................................................................... 50 Review settings and activate your Volume Gateway ..................................................................... 51 Conﬁgure your Volume Gateway ....................................................................................................... 52 Creating a volume ...................................................................................................................................... 54 Conﬁgure CHAP authentication for your volumes ......................................................................... 56 Connecting your volumes to your client ............................................................................................... 57 Connecting to a Microsoft Windows client ..................................................................................... 58 Connecting to a Red Hat Enterprise Linux client ........................................................................... 58 Initializing and formatting your volume ............................................................................................... 59 Initializing and formatting on Windows .......................................................................................... 60 Initializing and formatting on RHEL ................................................................................................. 61 Testing your gateway ................................................................................................................................ 62 Backing up your volumes ......................................................................................................................... 64 Using Storage Gateway to back up your volumes ......................................................................... 64 Using AWS Backup to back up your volumes ................................................................................. 64 Where do I go from here? ........................................................................................................................ 67 Sizing Your Volume Gateway's Storage for Real-World Workloads ............................................ 68 Activating your gateway in a virtual private cloud ............................................................................. 69 Creating a VPC endpoint for Storage Gateway .............................................................................. 70 Managing Your Volume Gateway ................................................................................................. 72 Editing Gateway Information ................................................................................................................... 73 Adding and expanding volumes ............................................................................................................. 74 Cloning a volume ....................................................................................................................................... 75 Viewing volume usage .............................................................................................................................. 76 Deleting storage volumes ........................................................................................................................ 77 Moving Your Volumes to a Diﬀerent Gateway ..................................................................................... 78 Creating a recovery snapshot .................................................................................................................. 80 Editing a snapshot schedule .................................................................................................................... 81 Deleting Snapshots .................................................................................................................................... 82 Using the AWS SDK for Java .............................................................................................................. 82 API Version 2013-06-30 iv AWS Storage Gateway Volume Gateway User Guide Using the AWS SDK for .NET .............................................................................................................. 86 Using the AWS Tools for Windows PowerShell .............................................................................. 92 Understanding Volume Status and Transitions ................................................................................... 95 Understanding Volume Status ........................................................................................................... 95 Understanding Volume Status ........................................................................................................... 99 Understanding Cached Volume Status Transitions ...................................................................... 100 Understanding Stored Volume Status Transitions ....................................................................... 103 Moving your data to a new gateway ................................................................................................... 105 Moving stored volumes to a new stored Volume Gateway ....................................................... 106 Moving cached volumes to a new gateway virtual machine ..................................................... 108 Monitoring Storage Gateway ...................................................................................................... 112 Understanding gateway metrics ........................................................................................................... 112 Dimensions for Storage Gateway metrics ..................................................................................... 118 Monitoring the upload buﬀer ............................................................................................................... 119 Monitoring cache storage ...................................................................................................................... 121 Understanding CloudWatch alarms ..................................................................................................... 123 Creating recommended CloudWatch alarms ...................................................................................... 124 Creating a custom CloudWatch alarm ................................................................................................. 125 Monitoring your Volume Gateway ....................................................................................................... 127 Getting Volume Gateway health logs ............................................................................................ 128 Using Amazon CloudWatch Metrics ................................................................................................ 129 Measuring Performance Between Your Application and Gateway ........................................... 131 Measuring Performance Between Your Gateway and AWS ....................................................... 132 Understanding volume metrics ....................................................................................................... 136 Maintaining Your Gateway .......................................................................................................... 143 Managing local disks
storagegateway-vgw-ug-002	storagegateway-vgw-ug.pdf	2	virtual machine ..................................................... 108 Monitoring Storage Gateway ...................................................................................................... 112 Understanding gateway metrics ........................................................................................................... 112 Dimensions for Storage Gateway metrics ..................................................................................... 118 Monitoring the upload buﬀer ............................................................................................................... 119 Monitoring cache storage ...................................................................................................................... 121 Understanding CloudWatch alarms ..................................................................................................... 123 Creating recommended CloudWatch alarms ...................................................................................... 124 Creating a custom CloudWatch alarm ................................................................................................. 125 Monitoring your Volume Gateway ....................................................................................................... 127 Getting Volume Gateway health logs ............................................................................................ 128 Using Amazon CloudWatch Metrics ................................................................................................ 129 Measuring Performance Between Your Application and Gateway ........................................... 131 Measuring Performance Between Your Gateway and AWS ....................................................... 132 Understanding volume metrics ....................................................................................................... 136 Maintaining Your Gateway .......................................................................................................... 143 Managing local disks ............................................................................................................................... 143 Deciding the amount of local disk storage ................................................................................... 144 Add upload buﬀer or cache storage .............................................................................................. 147 Managing Bandwidth .............................................................................................................................. 148 Changing Bandwidth Throttling Using the Storage Gateway Console .................................... 149 Scheduling Bandwidth Throttling ................................................................................................... 149 Using the AWS SDK for Java ........................................................................................................... 151 Using the AWS SDK for .NET ........................................................................................................... 153 Using the AWS Tools for Windows PowerShell ............................................................................ 155 Managing gateway updates ................................................................................................................... 156 Update frequency and expected behavior .................................................................................... 157 API Version 2013-06-30 v AWS Storage Gateway Volume Gateway User Guide Turn maintenance updates on or oﬀ ............................................................................................. 157 Modify the gateway maintenance window schedule .................................................................. 158 Apply an update manually ............................................................................................................... 159 Shutting Down Your Gateway VM ........................................................................................................ 160 Starting and Stopping a Volume Gateway ................................................................................... 161 Deleting your gateway and removing resources ............................................................................... 162 Deleting Your Gateway by Using the Storage Gateway Console .............................................. 162 Removing Resources from a Gateway Deployed On-Premises .................................................. 164 Removing Resources from a Gateway Deployed on an Amazon EC2 Instance ....................... 164 Performing maintenance tasks using the local console ............................................................ 166 Accessing the Gateway Local Console ................................................................................................. 166 Accessing the Gateway Local Console with Linux KVM .............................................................. 167 Accessing the Gateway Local Console with VMware ESXi .......................................................... 167 Access the Gateway Local Console with Microsoft Hyper-V ...................................................... 168 Performing Tasks on the VM Local Console ...................................................................................... 169 Logging in to the Volume Gateway local console ....................................................................... 170 Conﬁguring a SOCKS5 proxy for your on-premises gateway .................................................... 172 Conﬁguring Your Gateway Network ............................................................................................... 173 Testing your gateway connectivity to the internet ..................................................................... 178 Running storage gateway commands in the local console for an on-premises gateway ..... 179 Viewing your gateway system resource status ............................................................................. 181 Performing Tasks on the EC2 Local Console ..................................................................................... 182 Logging In to Your EC2 Gateway Local Console .......................................................................... 183 Conﬁguring an HTTP proxy .............................................................................................................. 184 Testing gateway network connectivity .......................................................................................... 185 Viewing your gateway system resource status ............................................................................. 186 Running Storage Gateway commands on the local console ..................................................... 187 Performance and optimization for Volume Gateway ................................................................ 189 Optimizing gateway performance ........................................................................................................ 189 Recommended Conﬁguration .......................................................................................................... 189 Add Resources to Your Gateway ..................................................................................................... 190 Optimize iSCSI Settings .................................................................................................................... 193 Add Resources to Your Application Environment ........................................................................ 193 Security ........................................................................................................................................ 195 Data protection ........................................................................................................................................ 196 Data encryption .................................................................................................................................. 197 API Version 2013-06-30 vi AWS Storage Gateway Volume Gateway User Guide Conﬁguring CHAP authentication ................................................................................................... 198 Identity and Access Management ........................................................................................................ 200 Audience ............................................................................................................................................... 200 Authenticating with identities ......................................................................................................... 201 Managing access using policies ....................................................................................................... 204 How AWS Storage Gateway works with IAM ................................................................................ 207 Identity-based policy examples ....................................................................................................... 213 Troubleshooting .................................................................................................................................. 216 Compliance validation ............................................................................................................................ 218 Resilience ................................................................................................................................................... 219 Infrastructure Security ............................................................................................................................ 219 AWS Security Best Practices .................................................................................................................. 220 Logging and Monitoring ......................................................................................................................... 220 Storage Gateway Information in CloudTrail ................................................................................. 221 Understanding Storage Gateway Log File Entries ....................................................................... 222 Troubleshooting gateway issues ................................................................................................. 224 Troubleshooting: gateway oﬄine issues ............................................................................................. 224 Check the associated ﬁrewall or proxy .......................................................................................... 225 Check for an ongoing SSL or deep-packet inspection of your gateway's traﬃc .................... 225 Check for a power outage or hardware failure on the hypervisor host ................................... 225 Check for issues with an associated cache disk ........................................................................... 225 Troubleshooting: gateway activation issues ....................................................................................... 226 Resolve errors when activating your gateway using a public endpoint ................................... 227 Resolve errors when activating your gateway using an Amazon VPC endpoint .................... 230 Resolve errors when activating your gateway using a public endpoint and there is a Storage Gateway VPC endpoint in the same VPC ....................................................................... 234 Troubleshooting on-premises gateway issues ................................................................................... 234 Activating Support to help troubleshoot your gateway ............................................................. 239 Troubleshooting Microsoft Hyper-V setup issues ............................................................................. 240 Troubleshooting Amazon EC2 gateway issues ................................................................................... 244 Gateway activation hasn't occurred after a few moments ........................................................ 244 Can't ﬁnd the EC2 gateway instance in the instance list ........................................................... 245 Can't attach a an Amazon EBS volume to the EC2 gateway instance ..................................... 245 Can't attach an initiator to a volume target of the EC2 gateway ............................................. 245 No disks available when you try to add storage volumes message ......................................... 246 How to remove a disk allocated as upload buﬀer space to reduce upload buﬀer space ...... 246 API Version 2013-06-30 vii AWS Storage Gateway Volume Gateway User Guide Throughput to or from the
storagegateway-vgw-ug-003	storagegateway-vgw-ug.pdf	3	gateway issues ................................................................................... 244 Gateway activation hasn't occurred after a few moments ........................................................ 244 Can't ﬁnd the EC2 gateway instance in the instance list ........................................................... 245 Can't attach a an Amazon EBS volume to the EC2 gateway instance ..................................... 245 Can't attach an initiator to a volume target of the EC2 gateway ............................................. 245 No disks available when you try to add storage volumes message ......................................... 246 How to remove a disk allocated as upload buﬀer space to reduce upload buﬀer space ...... 246 API Version 2013-06-30 vii AWS Storage Gateway Volume Gateway User Guide Throughput to or from the EC2 gateway drops to zero ............................................................. 246 Activating Support to help troubleshoot the gateway ............................................................... 246 Connect to your Amazon EC2 gateway using the serial console .............................................. 248 Troubleshooting hardware appliance issues ...................................................................................... 248 How to determine service IP address ............................................................................................. 249 How to perform a factory reset ...................................................................................................... 249 How to perform a remote restart ................................................................................................... 249 How to obtain Dell iDRAC support ................................................................................................. 249 How to ﬁnd the hardware appliance serial number ................................................................... 249 How to get hardware appliance support ....................................................................................... 250 Troubleshooting volume issues ............................................................................................................. 250 The Console Says That Your Volume Is Not Conﬁgured ............................................................ 251 The Console Says That Your Volume Is Irrecoverable ................................................................. 251 Your Cached Gateway is Unreachable And You Want to Recover Your Data .......................... 252 The Console Says That Your Volume Has PASS THROUGH Status ........................................... 252 You Want to Verify Volume Integrity and Fix Possible Errors ................................................... 253 Your Volume's iSCSI Target Doesn’t Appear in Windows Disk Management Console ........... 253 You Want to Change Your Volume's iSCSI Target Name ............................................................ 253 Your Scheduled Volume Snapshot Did Not Occur ....................................................................... 253 You Need to Remove or Replace a Disk That Has Failed ........................................................... 254 Throughput from Your Application to a Volume Has Dropped to Zero ................................... 254 A Cache Disk in Your Gateway Encounters a Failure ................................................................... 255 A Volume Snapshot Has PENDING Status Longer Than Expected ........................................... 255 High Availability Health Notiﬁcations ............................................................................................ 255 Troubleshooting high availability issues ............................................................................................. 256 Health notiﬁcations ............................................................................................................................ 256 Metrics ................................................................................................................................................... 257 Best practices ............................................................................................................................... 258 Best practices: recovering your data .................................................................................................... 258 Recovering from an unexpected VM shutdown ........................................................................... 259 Recovering data from malfunctioning gateway or VM ............................................................... 259 Recovering data from an irrecoverable volume ........................................................................... 260 Recovering data from a malfunctioning cache disk .................................................................... 260 Recovering data from a corrupted ﬁle system ............................................................................. 260 Recovering data from an inaccessible data center ...................................................................... 262 Cleaning up unnecessary resources ..................................................................................................... 262 API Version 2013-06-30 viii AWS Storage Gateway Volume Gateway User Guide Reducing the amount of billed storage on a volume ...................................................................... 263 Additional Resources ................................................................................................................... 264 Host setup ................................................................................................................................................. 264 Deploy a default Amazon EC2 host for Volume Gateway .......................................................... 265 Deploy a customized Amazon EC2 instance for Volume Gateway ........................................... 268 Modify Amazon EC2 instance metadata options ......................................................................... 272 Synchronize VM time with Hyper-V or Linux KVM host time .................................................... 272 Synchronize VM time with VMware host time ............................................................................. 273 Conﬁgure paravirtualized disk controllers .................................................................................... 275 Conﬁguring network adapters for your gateway ......................................................................... 275 Using VMware High Availability with Storage Gateway ............................................................. 280 Working with Volume Gateway storage resources ........................................................................... 285 Removing Disks from Your Gateway .............................................................................................. 286 EBS Volumes for EC2 Gateways ...................................................................................................... 287 Getting Activation Key ............................................................................................................................ 288 Linux (curl) ........................................................................................................................................... 289 Linux (bash/zsh) .................................................................................................................................. 290 Microsoft Windows PowerShell ....................................................................................................... 291 Using your local console ................................................................................................................... 291 Connecting iSCSI Initiators .................................................................................................................... 292 Connecting to your volumes from a Windows client .................................................................. 293 Connecting volumes to a Linux client ............................................................................................ 296 Customizing iSCSI Settings .............................................................................................................. 298 Conﬁguring CHAP Authentication .................................................................................................. 304 Using AWS Direct Connect with Storage Gateway ........................................................................... 309 Getting the gateway IP address ........................................................................................................... 310 Getting an IP Address from an Amazon EC2 Host ...................................................................... 311 Understanding Resources and Resource IDs ...................................................................................... 312 Working with Resource IDs ............................................................................................................... 312 Tagging Your Resources ......................................................................................................................... 313 Working with Tags ............................................................................................................................. 313 Open-Source Components ..................................................................................................................... 315 Storage Gateway quotas ........................................................................................................................ 315 Quotas for volumes ........................................................................................................................... 315 Recommended local disk sizes for your gateway ........................................................................ 316 API Reference ............................................................................................................................... 318 API Version 2013-06-30 ix AWS Storage Gateway Volume Gateway User Guide Required Request Headers ..................................................................................................................... 318 Signing Requests ...................................................................................................................................... 321 Example Signature Calculation ........................................................................................................ 321 Error Responses ........................................................................................................................................ 323 Exceptions ............................................................................................................................................ 324 Operation Error Codes ....................................................................................................................... 326 Error Responses .................................................................................................................................. 345 Operations ................................................................................................................................................. 347 Document history ........................................................................................................................ 348 Earlier updates .......................................................................................................................................... 364 Release notes ............................................................................................................................... 383 API Version 2013-06-30 x AWS Storage Gateway Volume Gateway User Guide What is Volume 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-eﬀective storage that helps maintain data
storagegateway-vgw-ug-004	storagegateway-vgw-ug.pdf	4	........................................................................................................ 321 Error Responses ........................................................................................................................................ 323 Exceptions ............................................................................................................................................ 324 Operation Error Codes ....................................................................................................................... 326 Error Responses .................................................................................................................................. 345 Operations ................................................................................................................................................. 347 Document history ........................................................................................................................ 348 Earlier updates .......................................................................................................................................... 364 Release notes ............................................................................................................................... 383 API Version 2013-06-30 x AWS Storage Gateway Volume Gateway User Guide What is Volume 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-eﬀective 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 oﬀers ﬁle-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 Volume Gateway. Volume Gateway provides cloud-backed storage volumes that you can mount as Internet Small Computer System Interface (iSCSI) devices from your on-premises application servers. Volume Gateway supports the following volume conﬁgurations: • Cached volumes – You store your data in Amazon Simple Storage Service (Amazon S3) and retain a copy of frequently accessed data subsets locally. Cached volumes oﬀer a substantial cost savings on primary storage and minimize the need to scale your storage on-premises. You also retain low-latency access to your frequently accessed data. • Stored volumes – If you need low-latency access to your entire dataset, ﬁrst conﬁgure your on-premises gateway to store all your data locally. Then asynchronously back up point-in- time snapshots of this data to Amazon S3. This conﬁguration provides durable and inexpensive oﬀsite backups that you can recover to your local data center or Amazon Elastic Compute Cloud (Amazon EC2). For example, if you need replacement capacity for disaster recovery, you can recover the backups to Amazon EC2. For an architectural overview, see How Volume Gateway works. API Version 2013-06-30 1 AWS Storage Gateway Volume Gateway User Guide In this User Guide, you can ﬁnd a Getting Started section that covers setup information common to all gateway types. You can also ﬁnd Volume Gateway setup requirements, and sections that describe how to deploy, activate, conﬁgure, and manage your Volume 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 Volume Gateway works Following, you can ﬁnd an architectural overview of the Volume Gateway solution. Volume Gateways For Volume Gateways, you can use either cached volumes or stored volumes. Topics • Cached volumes architecture • Stored volumes architecture Cached volumes architecture By using cached volumes, you can use Amazon S3 as your primary data storage, while retaining frequently accessed data locally in your Storage Gateway. Cached volumes minimize the need to scale your on-premises storage infrastructure, while still providing your applications with low- latency access to their frequently accessed data. You can create storage volumes up to 32 TiB in size and attach to them as iSCSI devices from your on-premises application servers. Your gateway stores data that you write to these volumes in Amazon S3 and retains recently read data in your on-premises Storage Gateway's cache and upload buﬀer storage. Cached volumes can range from 1 GiB to 32 TiB in size and must be rounded to the nearest GiB. Each gateway conﬁgured for cached volumes can support up to 32 volumes for a total maximum storage volume of 1,024 TiB (1 PiB). In the cached volumes solution, Storage Gateway stores all your on-premises application data in a storage volume in Amazon S3. The following diagram provides an overview of the cached volumes deployment. How Volume Gateway works API Version 2013-06-30 2 AWS Storage Gateway Volume Gateway User Guide After you install the Storage Gateway software appliance—the VM—on a host in your data center and activate it, you use the AWS Management Console to provision storage volumes backed by Amazon S3. You can also provision storage volumes programmatically using the Storage Gateway API or the AWS SDK libraries. You then mount these storage volumes to your on-premises application servers as iSCSI devices. You also allocate disks on-premises for the VM. These on-premises disks serve the following purposes: • Disks for use by the gateway as cache storage – As your applications write
storagegateway-vgw-ug-005	storagegateway-vgw-ug.pdf	5	AWS Storage Gateway Volume Gateway User Guide After you install the Storage Gateway software appliance—the VM—on a host in your data center and activate it, you use the AWS Management Console to provision storage volumes backed by Amazon S3. You can also provision storage volumes programmatically using the Storage Gateway API or the AWS SDK libraries. You then mount these storage volumes to your on-premises application servers as iSCSI devices. You also allocate disks on-premises for the VM. These on-premises disks serve the following purposes: • Disks for use by the gateway as cache storage – As your applications write data to the storage volumes in AWS, the gateway ﬁrst stores the data on the on-premises disks used for cache storage. Then the gateway uploads the data to Amazon S3. The cache storage acts as the on- premises durable store for data that is waiting to upload to Amazon S3 from the upload buﬀer. The cache storage also lets the gateway store your application's recently accessed data on- premises for low-latency access. If your application requests data, the gateway ﬁrst checks the cache storage for the data before checking Amazon S3. You can use the following guidelines to determine the amount of disk space to allocate for cache storage. Generally, you should allocate at least 20 percent of your existing ﬁle store size as cache storage. Cache storage should also be larger than the upload buﬀer. This guideline helps make sure that cache storage is large enough to persistently hold all data in the upload buﬀer that has not yet been uploaded to Amazon S3. Volume Gateways API Version 2013-06-30 3 AWS Storage Gateway Volume Gateway User Guide • Disks for use by the gateway as the upload buﬀer – To prepare for upload to Amazon S3, your gateway also stores incoming data in a staging area, referred to as an upload buﬀer. Your gateway uploads this buﬀer data over an encrypted Secure Sockets Layer (SSL) connection to AWS, where it is stored encrypted in Amazon S3. You can take incremental backups, called snapshots, of your storage volumes in Amazon S3. These point-in-time snapshots are also stored in Amazon S3 as Amazon EBS snapshots. When you take a new snapshot, only the data that has changed since your last snapshot is stored. When the snapshot is taken, the gateway uploads the changes up to the snapshot point, then creates the new snapshot using Amazon EBS. You can initiate snapshots on a scheduled or one-time basis. A single volume supports queueing multiple snapshots in rapid succession, but each snapshot must ﬁnish being created before the next can be taken. When you delete a snapshot, only the data not needed for any other snapshots is removed. For information about Amazon EBS snapshots, see Amazon EBS snapshots. You can restore an Amazon EBS snapshot to a gateway storage volume if you need to recover a backup of your data. Alternatively, for snapshots up to 16 TiB in size, you can use the snapshot as a starting point for a new Amazon EBS volume. You can then attach this new Amazon EBS volume to an Amazon EC2 instance. All gateway data and snapshot data for cached volumes is stored in Amazon S3 and encrypted at rest using server-side encryption (SSE). However, you can't access this data with the Amazon S3 API or other tools such as the Amazon S3 Management Console. Stored volumes architecture By using stored volumes, you can store your primary data locally, while asynchronously backing up that data to AWS. Stored volumes provide your on-premises applications with low-latency access to their entire datasets. At the same time, they provide durable, oﬀsite backups. You can create storage volumes and mount them as iSCSI devices from your on-premises application servers. Data written to your stored volumes is stored on your on-premises storage hardware. This data is asynchronously backed up to Amazon S3 as Amazon Elastic Block Store (Amazon EBS) snapshots. Stored volumes can range from 1 GiB to 16 TiB in size and must be rounded to the nearest GiB. Each gateway conﬁgured for stored volumes can support up to 32 volumes and a total volume storage of 512 TiB (0.5 PiB). With stored volumes, you maintain your volume storage on-premises in your data center. That is, you store all your application data on your on-premises storage hardware. Then, using features Volume Gateways API Version 2013-06-30 4 AWS Storage Gateway Volume Gateway User Guide that help maintain data security, the gateway uploads data to the Amazon Web Services Cloud for cost-eﬀective backup and rapid disaster recovery. This solution is ideal if you want to keep data locally on-premises, because you need to have low-latency access to all your data, and also to maintain backups in AWS. The following diagram provides an overview of
storagegateway-vgw-ug-006	storagegateway-vgw-ug.pdf	6	stored volumes, you maintain your volume storage on-premises in your data center. That is, you store all your application data on your on-premises storage hardware. Then, using features Volume Gateways API Version 2013-06-30 4 AWS Storage Gateway Volume Gateway User Guide that help maintain data security, the gateway uploads data to the Amazon Web Services Cloud for cost-eﬀective backup and rapid disaster recovery. This solution is ideal if you want to keep data locally on-premises, because you need to have low-latency access to all your data, and also to maintain backups in AWS. The following diagram provides an overview of the stored volumes deployment. After you install the Storage Gateway software appliance—the VM—on a host in your data center and activated it, you can create gateway storage volumes. You then map them to on-premises direct-attached storage (DAS) or storage area network (SAN) disks. You can start with either new disks or disks already holding data. You can then mount these storage volumes to your on- premises application servers as iSCSI devices. As your on-premises applications write data to and read data from a gateway's storage volume, this data is stored and retrieved from the volume's assigned disk. To prepare data for upload to Amazon S3, your gateway also stores incoming data in a staging area, referred to as an upload buﬀer. You can use on-premises DAS or SAN disks for working storage. Your gateway uploads data from the upload buﬀer over an encrypted Secure Sockets Layer (SSL) connection to the Storage Gateway service running in the Amazon Web Services Cloud. The service then stores the data encrypted in Amazon S3. You can take incremental backups, called snapshots, of your storage volumes. The gateway stores these snapshots in Amazon S3 as Amazon EBS snapshots. When you take a new snapshot, only the data that has changed since your last snapshot is stored. When the snapshot is taken, the gateway Volume Gateways API Version 2013-06-30 5 AWS Storage Gateway Volume Gateway User Guide uploads the changes up to the snapshot point, then creates the new snapshot using Amazon EBS. You can initiate snapshots on a scheduled or one-time basis. A single volume supports queueing multiple snapshots in rapid succession, but each snapshot must ﬁnish being created before the next can be taken. When you delete a snapshot, only the data not needed for any other snapshot is removed. You can restore an Amazon EBS snapshot to an on-premises gateway storage volume if you need to recover a backup of your data. You can also use the snapshot as a starting point for a new Amazon EBS volume, which you can then attach to an Amazon EC2 instance. Volume Gateways API Version 2013-06-30 6 AWS Storage Gateway Volume 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, conﬁguration, and maintenance tasks. If you are a ﬁrst-time user, we recommend that you review the Supported AWS regions and Volume 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
storagegateway-vgw-ug-007	storagegateway-vgw-ug.pdf	7	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 7 AWS Storage Gateway Volume Gateway User Guide 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a veriﬁcation 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 Conﬁgure programmatic access by Conﬁguring 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 8 AWS Storage Gateway Volume 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 Conﬁgure 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 conﬁguration and maintenance tasks, including activating or removing Storage Gateway hardware appliances from your deployment, creating, managing, and deleting the diﬀerent types of gateways, creating, managing, and deleting storage volumes, 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 9 AWS Storage Gateway Volume 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
storagegateway-vgw-ug-008	storagegateway-vgw-ug.pdf	8	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. 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 oﬀered 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 speciﬁc 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 10 AWS Storage Gateway Volume Gateway User Guide Requirements for setting up Volume Gateway Unless otherwise noted, the following requirements are common to all gateway conﬁgurations. Topics • Hardware and storage requirements • Network and ﬁrewall requirements • Supported hypervisors and host requirements • Supported iSCSI initiators 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 Volume 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 aﬀects the performance of the gateway VM, see AWS Storage Gateway quotas. 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. Hardware and storage requirements API Version 2013-06-30 11 AWS Storage Gateway Note Volume Gateway User Guide 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 Volume 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 cached volumes • 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. Gateway
storagegateway-vgw-ug-009	storagegateway-vgw-ug.pdf	9	your gateway type. Recommended for cached volumes • 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. Gateway Type Cache (Minimum) Cache (Maximum) Upload Buﬀer Upload Buﬀer Other Required (Minimum) (Maximum) Local Disks 150 GiB 64 TiB 150 GiB 2 TiB — Cached Volume Gateway Storage requirements API Version 2013-06-30 12 AWS Storage Gateway Volume Gateway User Guide Gateway Type Cache (Minimum) Cache (Maximum) Upload Buﬀer Upload Buﬀer Other Required (Minimum) (Maximum) Local Disks — — 150 GiB 2 TiB 1 or more for stored volume or volumes Stored Volume Gateway Note You can conﬁgure one or more local drives for your cache and upload buﬀer, up to the maximum capacity. When adding cache or upload buﬀer 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 buﬀer. For information about gateway quotas, see AWS Storage Gateway quotas. Network and ﬁrewall requirements Your gateway requires access to the internet, local networks, Domain Name Service (DNS) servers, ﬁrewalls, routers, and so on. Following, you can ﬁnd information about required ports and how to allow access through ﬁrewalls 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 ﬁrewall requirements API Version 2013-06-30 13 AWS Storage Gateway Note Volume 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 ﬁrewall requirements for the Storage Gateway Hardware Appliance • Allowing AWS Storage Gateway access through ﬁrewalls and routers • Conﬁguring security groups for your Amazon EC2 gateway instance Port requirements Volume Gateway requires speciﬁc 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 speciﬁc conﬁgurations, such as when connecting to VPC endpoints. Port requirements for Volume 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 14 AWS Storage Gateway Volume 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 conﬁgura tion. If you activate your gateway Port requirements API Version 2013-06-30 15 AWS Storage Gateway Volume 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 16 AWS Storage Gateway Volume 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 17 AWS Storage Gateway Volume Gateway User Guide Network Element NTP From To Protocol Port Inbound Outbound Required Notes 123 ✓ ✓ ✓ Storage Gateway Network Time TCP
storagegateway-vgw-ug-010	storagegateway-vgw-ug.pdf	10	Gateway AWS TCP HTTPS VM 443 ✓ ✓ ✓ Port requirements API Version 2013-06-30 16 AWS Storage Gateway Volume 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 17 AWS Storage Gateway Volume 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 conﬁgure 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 18 AWS Storage Gateway Volume 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 19 AWS Storage Gateway Volume 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 20 AWS Storage Gateway Volume 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 21 AWS Storage Gateway Volume 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 22 AWS Storage Gateway Volume 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 23 AWS Storage Gateway Volume 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 traﬃc ﬂow for a basic Volume Gateway deployment. Port requirements API Version 2013-06-30 24 AWS Storage Gateway Volume Gateway User Guide Networking and ﬁrewall 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 conﬁgured Amazon NTP time service must be reachable. • IP address – A DHCP or static IPv4 address assigned. You cannot assign an IPv6 address. There are ﬁve 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 ﬁrewall requirements for the hardware appliance API Version 2013-06-30 25 AWS Storage Gateway Volume 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 brieﬂy) To perform as
storagegateway-vgw-ug-011	storagegateway-vgw-ug.pdf	11	em3 5. em4 You can use the iDRAC port for remote server management. A hardware appliance requires the following ports to operate. Networking and ﬁrewall requirements for the hardware appliance API Version 2013-06-30 25 AWS Storage Gateway Volume 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 brieﬂy) To perform as designed, a hardware appliance requires network and ﬁrewall settings as follows: • Conﬁgure 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. • Conﬁgure at least one network interface to support the hardware appliance. For more information, see Conﬁguring 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 ﬁrewall requirements for the hardware appliance API Version 2013-06-30 26 AWS Storage Gateway Volume 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 conﬁguring a hardware appliance, see Using the Storage Gateway Hardware Appliance. Allowing AWS Storage Gateway access through ﬁrewalls and routers Your gateway requires access to the following service endpoints to communicate with AWS. If you use a ﬁrewall or router to ﬁlter or limit network traﬃc, you must conﬁgure your ﬁrewall and router to allow these service endpoints for outbound communication to AWS. Allowing gateway access through ﬁrewall and routers API Version 2013-06-30 27 AWS Storage Gateway Note Volume Gateway User Guide If you conﬁgure 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 conﬁgured 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 ﬁrewall and routers API Version 2013-06-30 28 AWS Storage Gateway Volume 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. Conﬁguring security groups for your Amazon EC2 gateway instance A security group controls traﬃc to your Amazon EC2 gateway instance. When you conﬁgure 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 conﬁgure access so the initiator can communicate with your gateway. For information about the ports to open for your gateway, see Port requirements. Conﬁguring security group API Version 2013-06-30 29 AWS Storage Gateway Volume Gateway User Guide
storagegateway-vgw-ug-012	storagegateway-vgw-ug.pdf	12	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 conﬁgure access so the initiator can communicate with your gateway. For information about the ports to open for your gateway, see Port requirements. Conﬁguring security group API Version 2013-06-30 29 AWS Storage Gateway Volume 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 speciﬁc 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 ﬁle, 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 Volume 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 30 AWS Storage Gateway Volume 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 cached volume or stored Volume Gateway, you can create iSCSI storage volumes on your gateway. 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 ﬁle system) without using WSFC. Supported iSCSI initiators API Version 2013-06-30 31 AWS Storage Gateway Volume 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 oﬀered. 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 conﬁguration. 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 ﬁrewall. 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 conﬁgure the hardware appliance
storagegateway-vgw-ug-013	storagegateway-vgw-ug.pdf	13	Appliance is a physical hardware appliance with the Storage Gateway software preinstalled on a validated server conﬁguration. 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 ﬁrewall. 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 conﬁgure 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 ﬁnd instructions about how to set up, rack mount, power, conﬁgure, 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 • Conﬁguring hardware appliance network parameters • Activating your Storage Gateway Hardware Appliance API Version 2013-06-30 32 AWS Storage Gateway Volume Gateway User Guide • Creating a gateway on your hardware appliance • Conﬁguring 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 oﬀered. 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 conﬁgure 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 conﬁgure 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 Conﬁguring 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 Creating a Volume 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 Volume 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 ﬁve 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 ﬁve 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 conﬁguration: • Use CAT6 cables for 10G or CAT5(e) for 1G • 10G DA/SFP+ NIC conﬁguration: • 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 oﬀered. Existing customers with the AWS Storage Gateway Hardware Appliance can continue to use and receive support until May 2028. As an alternative, you
storagegateway-vgw-ug-014	storagegateway-vgw-ug.pdf	14	10G DA/SFP+ network card. • 10G-Base-T NIC conﬁguration: • Use CAT6 cables for 10G or CAT5(e) for 1G • 10G DA/SFP+ NIC conﬁguration: • 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 oﬀered. 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 Volume Gateway User Guide Your appliance has a 1U form factor and ﬁts 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 ﬁrewall 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 Volume Gateway User Guide 3. Plug an Ethernet cable into the em1 port to provide an always-on internet connection. The em1 port is the ﬁrst 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 oﬀered. 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 Volume 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 speciﬁc to AWS that you can use to set an administrator password, conﬁgure 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 ﬁrst 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 Conﬁrm, 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: • Conﬁgure Network • Open Service Console • Change Password • Logout • Open Support
storagegateway-vgw-ug-015	storagegateway-vgw-ug.pdf	15	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 Conﬁrm, 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: • Conﬁgure Network • Open Service Console • Change Password • Logout • Open Support Console Next step Conﬁguring hardware appliance network parameters Accessing the hardware appliance console API Version 2013-06-30 37 AWS Storage Gateway Volume Gateway User Guide Conﬁguring hardware appliance network parameters Note End of availability notice: As of May 12, 2025, the AWS Storage Gateway Hardware Appliance will no longer be oﬀered. 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 conﬁgure network parameters so your hardware appliance can connect to AWS. To set a network address 1. From the Home page, choose Conﬁgure Network and then press Enter. The Conﬁgure Network page appears. The Conﬁgure Network page shows IP and DNS information for each of the 4 network interfaces on the hardware appliance, and includes menu options to conﬁgure 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 Conﬁguration Protocol (DHCP) server to your physical network port. Note this address for later use in the activation step. • Choose Static and press Enter to conﬁgure a static IPv4 address. Enter a valid IP Address, Subnet Mask, Gateway, and DNS server address for the em1 network interface. When ﬁnished, choose Save and then press Enter to save the conﬁguration. Conﬁguring hardware appliance network parameters API Version 2013-06-30 38 AWS Storage Gateway Note Volume Gateway User Guide You can use this procedure to conﬁgure other network interfaces in addition to em1. If you conﬁgure 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 conﬁguring 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 oﬀered. 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 conﬁguring 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 Volume 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 ﬁrewall must allow HTTP access on port 8080 to the appliance for inbound traﬃc. 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 conﬁgured for your hardware appliance, then choose Connect. 5. 6. For more information about conﬁguring the IP address, see Conﬁguring 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
storagegateway-vgw-ug-016	storagegateway-vgw-ug.pdf	16	be on the same network as your hardware appliance. • Your ﬁrewall must allow HTTP access on port 8080 to the appliance for inbound traﬃc. 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 conﬁgured for your hardware appliance, then choose Connect. 5. 6. For more information about conﬁguring the IP address, see Conﬁguring 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 ﬁnish 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 Volume Gateway User Guide At this point, the appliance is associated with your account. The next step is to conﬁgure 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 oﬀered. 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 conﬁgure the type of Storage Gateway that you want to deploy. When you ﬁnish creating your gateway in the Storage Gateway console, the Storage Gateway software automatically starts installing on the hardware appliance. If you use Dynamic Host Conﬁguration 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 Conﬁguring an IP address for the gateway. To assign a static IP address to your installed gateway, you next conﬁgure 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 Volume Gateway User Guide Conﬁguring a gateway IP address on the hardware appliance Conﬁguring 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 oﬀered. 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, conﬁgure 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 conﬁgure 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 conﬁguration 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
storagegateway-vgw-ug-017	storagegateway-vgw-ug.pdf	17	the gateway local console from the hardware appliance console using the Open Service Console option. To conﬁgure 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 conﬁguration 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 - Conﬁguration 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. Conﬁguring a gateway IP address on the hardware appliance API Version 2013-06-30 42 AWS Storage Gateway Volume Gateway User Guide For more information, see Setting the Local Console Password from the Storage Gateway Console. 3. The AWS Appliance Activation - Conﬁguration page includes the following menu options: • HTTP/SOCKS Proxy Conﬁguration • Network Conﬁguration • Test Network Connectivity • View System Resource Check • System Time Management • License Information • Command Prompt Note Some options appear only for speciﬁc gateway types or host platforms. Enter the corresponding numeral to navigate to the Network Conﬁguration page. 4. Do one of the following to conﬁgure the gateway IP address: • To use the IP address assigned by your Dynamic Host Conﬁguration Protocol (DHCP) server, enter the corresponding numeral for Conﬁgure DHCP, and then enter valid DHCP conﬁguration information on the following page. • To assign a static IP address, enter the corresponding numeral for Conﬁgure 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. • Conﬁguring a gateway IP address on the hardware appliance API Version 2013-06-30 43 AWS Storage Gateway Note Volume Gateway User Guide The keystroke preceding is the only way to exit the gateway local console. After your hardware appliance has been activated and conﬁgured, your appliance appears in the console. Now you can continue the setup and conﬁguration 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 oﬀered. 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 speciﬁc 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 conﬁrmation dialog box appears. Removing gateway software from your hardware appliance API Version 2013-06-30 44 AWS Storage Gateway Volume Gateway User Guide 4. Verify that you want to remove the gateway software from the speciﬁed hardware appliance, and then type the word remove in the conﬁrmation 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 oﬀered. 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
storagegateway-vgw-ug-018	storagegateway-vgw-ug.pdf	18	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 oﬀered. 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 diﬀerent AWS account or AWS Region, you must ﬁrst 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 Volume Gateway User Guide To delete your hardware appliance 1. If you have installed a gateway on the hardware appliance, you must ﬁrst 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 conﬁrmation dialog box appears. 4. Verify that you want to delete the speciﬁed hardware appliance, then type the word delete in the conﬁrmation 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 Volume 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 speciﬁc 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 ﬁrst 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 ﬁrst 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 Volume 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 conﬁguration. 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 conﬁgure some additional settings and create your storage resources. Overview - Gateway Conﬁguration After you activate your Storage Gateway, you need to perform some additional conﬁguration. 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 buﬀer by the gateway appliance. You then conﬁgure settings to help monitor the health of your gateway
storagegateway-vgw-ug-019	storagegateway-vgw-ug.pdf	19	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 conﬁgure some additional settings and create your storage resources. Overview - Gateway Conﬁguration After you activate your Storage Gateway, you need to perform some additional conﬁguration. 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 buﬀer by the gateway appliance. You then conﬁgure 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 conﬁgured gateway, you will need to create your storage resources. Overview - Storage Resources After you activate and conﬁgure 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 ﬁles 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. Creating a Volume Gateway In this section, you can ﬁnd instructions on how to download, deploy, and activate a Volume Gateway. Topics • Set up a Volume Gateway Review and activate API Version 2013-06-30 48 AWS Storage Gateway Volume Gateway User Guide • Connect your Volume Gateway to AWS • Review settings and activate your Volume Gateway • Conﬁgure your Volume Gateway Set up a Volume Gateway To set up a new Volume 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 ﬁnd 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. In the Gateway options section, for Gateway type, choose Volume Gateway, then choose the volume type your gateway will use. You can choose from the following options: • Cached volumes - Stores your primary data in Amazon S3 and retains frequently accessed data locally in cache for faster access. • Stored volumes - Stores all of your data locally while also backing it up asynchronously to Amazon S3. Gateways using this volume type cannot be deployed on Amazon EC2. 5. 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-speciﬁc 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 conﬁgure the gateway virtual machine using VMware ESXi. • Microsoft Hyper-V - Download, deploy, and conﬁgure the gateway virtual machine using Microsoft Hyper-V. • Linux KVM - Download, deploy, and conﬁgure the gateway virtual machine using Linux KVM. Set up a Volume Gateway API Version 2013-06-30 49 AWS Storage Gateway Volume Gateway User Guide • Amazon EC2 - Conﬁgure 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. b. For Conﬁrm set up gateway, select the check box to conﬁrm that you performed the deployment steps for the host platform you chose. This step is not applicable for the Hardware appliance host platform. 6. 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 Volume Gateway to AWS. Connect your Volume Gateway to AWS To connect a new Volume Gateway to AWS 1. Complete the procedure described in Set up a Volume Gateway if you have not done so already. When ﬁnished, 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
storagegateway-vgw-ug-020	storagegateway-vgw-ug.pdf	20	procedure described in Set up a Volume Gateway if you have not done so already. When ﬁnished, 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 Connect your Volume Gateway to AWS API Version 2013-06-30 50 AWS Storage Gateway Volume Gateway User Guide specify an existing VPC endpoint by choosing its VPC endpoint ID from the drop-down menu, or by providing its VPC endpoint DNS name or IP address. 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 ﬁeld. 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 ﬁeld. 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 Volume Gateway. Review settings and activate your Volume Gateway To activate a new Volume Gateway 1. Complete the procedures described in the following topics if you have not done so already: • Set up a Volume Gateway • Connect your Volume Gateway to AWS When ﬁnished, 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 Volume Gateway API Version 2013-06-30 51 AWS Storage Gateway Note Volume Gateway User Guide You cannot modify the gateway options or connection settings after your gateway is created. 4. Choose Activate gateway to proceed. Now that you have activated your gateway, you need to perform ﬁrst-time conﬁguration to allocate local storage disks and conﬁgure logging. For instructions, see Conﬁgure your Volume Gateway. Conﬁgure your Volume Gateway To perform ﬁrst-time conﬁguration on a new Volume Gateway 1. Complete the procedures described in the following topics if you have not done so already: • Set up a Volume Gateway • Connect your Volume Gateway to AWS • Review settings and activate your Volume Gateway When ﬁnished, choose Next to open the Conﬁgure gateway page in the Storage Gateway console. 2. In the Conﬁgure 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. Conﬁgure your Volume Gateway API Version 2013-06-30 52 AWS Storage Gateway Note Volume 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 speciﬁc log group resourceArn information for your deployment.
storagegateway-vgw-ug-021	storagegateway-vgw-ug.pdf	21	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. Conﬁgure your Volume Gateway API Version 2013-06-30 52 AWS Storage Gateway Note Volume 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 speciﬁc 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 deﬁned 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 preconﬁgured 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 Conﬁgure your Volume Gateway API Version 2013-06-30 53 AWS Storage Gateway Volume Gateway User Guide • cloudwatch:DisableAlarmActions - turn alarm actions oﬀ • cloudwatch:EnableAlarmActions - turn alarm actions on • cloudwatch:DeleteAlarms - delete alarms • Create a custom alarm – Conﬁgure a new CloudWatch alarm to notify you about your gateway's metrics. Choose Create alarm to deﬁne 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 notiﬁcations 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 ﬁlter for your gateway on list pages in the Storage Gateway console. Repeat this step to add as many tags as you need. 6. Choose Conﬁgure to ﬁnish 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 a volume for it to use. For instructions, see Creating a volume. Creating a storage volume Previously, you allocated local disks that you added to the VM cache storage and upload buﬀer. Now you create a storage volume to which your applications read and write data. The gateway maintains the volume's recently accessed data locally in cache storage, and asynchronously transferred data to Amazon S3. For stored volumes, you allocated local disks that you added to the VM upload buﬀer and your application's data. Note You can use AWS Key Management Service (AWS KMS) to encrypt data written to a cached volume that is stored in Amazon S3. Currently, you can do this by using the AWS Storage Gateway API Reference. For more information, see CreateCachediSCSIVolume or create- cached-iscsi-volume. Creating a volume API Version 2013-06-30 54 AWS Storage Gateway To create a volume Volume Gateway User Guide 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. On the Storage Gateway console, choose Create volume. 3. 4. 5. In the Create volume dialog box, choose a gateway for Gateway. For the cached volumes, enter the capacity in Capacity. For stored volumes, choose a Disk ID value from the list. For Volume content, your choices depend on the type of gateway that you're creating the volume for. For cached volumes, you have the following options: • Create a new empty volume. • Create a volume based on an Amazon EBS snapshot. If you choose this option, provide a value for EBS snapshot ID. Note Storage Gateway does not support creating cached volumes from snapshots of AWS Marketplace volumes. • Clone from last volume recovery point. If you choose this option, choose a volume ID for Source volume. If there are no volumes in the Region, this option doesn't appear. For stored volumes, you have the following options: • Create a new empty volume. • Create a volume based on a snapshot. If you choose this option, provide a value for EBS snapshot ID. • Preserve existing data on the disk 6. Enter a name for iSCSI target name. The target name can contain lowercase letters, numbers, periods (.), and hyphens (-). This target name appears as the iSCSI target node name in the Targets tab of the iSCSI Microsoft initiator UI after discovery. For example,
storagegateway-vgw-ug-022	storagegateway-vgw-ug.pdf	22	Source volume. If there are no volumes in the Region, this option doesn't appear. For stored volumes, you have the following options: • Create a new empty volume. • Create a volume based on a snapshot. If you choose this option, provide a value for EBS snapshot ID. • Preserve existing data on the disk 6. Enter a name for iSCSI target name. The target name can contain lowercase letters, numbers, periods (.), and hyphens (-). This target name appears as the iSCSI target node name in the Targets tab of the iSCSI Microsoft initiator UI after discovery. For example, the name target1 appears as Creating a volume API Version 2013-06-30 55 AWS Storage Gateway Volume Gateway User Guide iqn.1007-05.com.amazon:target1. Make sure that the target name is globally unique within your storage area network (SAN). 7. Verify that the Network interface setting has IP address selected, or choose an IP address for Network interface. For Network interface, one IP address appears for each adapter that is conﬁgured for the gateway VM. If the gateway VM is conﬁgured for only one network adapter, no Network interface list appears because there is only one IP address. Your iSCSI target will be available on the network adapter you choose. If you have deﬁned your gateway to use multiple network adapters, choose the IP address that your storage applications should use to access your volume. For information about conﬁguring multiple network adapters, see Conﬁguring Your Gateway for Multiple NICs. Note After you choose a network adapter, you can't change this setting. 8. (Optional) For Tags, enter a key and value to add tags to your volume. A tag is a case-sensitive key-value pair that helps you manage, ﬁlter, and search for your volumes. 9. Choose Create volume. If you have previously created volumes in this Region, you can see them listed on the Storage Gateway console. The Conﬁgure CHAP Authentication dialog box appears. At this point, you can conﬁgure Challenge-Handshake Authentication Protocol (CHAP) for your volume, or you can choose Cancel and conﬁgure CHAP later. For more information about CHAP setup, see Conﬁgure CHAP authentication for your volumes. If you don't want to set up CHAP, get started using your volume. For more information, see Connecting your volumes to your client. Conﬁgure CHAP authentication for your volumes CHAP provides protection against playback attacks by requiring authentication to access your storage volume targets. In the Conﬁgure CHAP Authentication dialog box, you provide information to conﬁgure CHAP for your volumes. Conﬁgure CHAP authentication for your volumes API Version 2013-06-30 56 AWS Storage Gateway To conﬁgure CHAP Volume Gateway User Guide 1. Choose the volume for which you want to conﬁgure CHAP. 2. 3. 4. 5. For Actions, choose Conﬁgure CHAP authentication. For Initiator Name, enter the name of your initiator. For Initiator secret, enter the secret phrase that you used to authenticate your iSCSI initiator. For Target secret, enter the secret phrase used to authenticate your target for mutual CHAP. 6. Choose Save to save your entries. For more information about setting up CHAP authentication, see Conﬁguring CHAP Authentication for Your iSCSI Targets. Next step Connecting your volumes to your client Connecting your volumes to your client You use the iSCSI initiator in your client to connect to your volumes. At the end of the following procedure, the volumes become available as local devices on your client. Important With Storage Gateway, you can connect multiple hosts to the same volume if the hosts coordinate access by using Windows Server Failover Clustering (WSFC). You can't connect multiple hosts to the same volume without using WSFC, for example by sharing a nonclustered NTFS/ext4 ﬁle system. Topics • Connecting to a Microsoft Windows client • Connecting to a Red Hat Enterprise Linux client Connecting your volumes to your client API Version 2013-06-30 57 AWS Storage Gateway Volume Gateway User Guide Connecting to a Microsoft Windows client The following procedure shows a summary of the steps that you follow to connect to a Windows client. For more information, see Connecting iSCSI Initiators. To connect to a Windows client 1. 2. 3. Start iscsicpl.exe. In the iSCSI Initiator Properties dialog box, choose the Discovery tab, and then choose Discovery Portal. In the Discover Target Portal dialog box, type the IP address of your iSCSI target for IP address or DNS name. 4. Connect the new target portal to the storage volume target on the gateway. 5. Choose the target, and then choose Connect. 6. In the Targets tab, make sure that the target status has the value Connected, indicating the target is connected, and then choose OK. Connecting to a Red Hat Enterprise Linux client The following procedure shows a summary of the steps that you follow to connect to a Red Hat Enterprise Linux (RHEL) client. For more information, see
storagegateway-vgw-ug-023	storagegateway-vgw-ug.pdf	23	the Discover Target Portal dialog box, type the IP address of your iSCSI target for IP address or DNS name. 4. Connect the new target portal to the storage volume target on the gateway. 5. Choose the target, and then choose Connect. 6. In the Targets tab, make sure that the target status has the value Connected, indicating the target is connected, and then choose OK. Connecting to a Red Hat Enterprise Linux client The following procedure shows a summary of the steps that you follow to connect to a Red Hat Enterprise Linux (RHEL) client. For more information, see Connecting iSCSI Initiators. To connect a Linux client to iSCSI targets 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 5 or 6, use the following command. sudo /etc/init.d/iscsi status For RHEL 7, 8, or 9, use the following command. Connecting to a Microsoft Windows client API Version 2013-06-30 58 AWS Storage Gateway Volume Gateway User Guide sudo service iscsid status 3. Discover the volume or VTL device targets deﬁned 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 should look 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. Make 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. lrwxrwxrwx. 1 root root 9 Apr 16 19:31 ip-[GATEWAY_IP]:3260-iscsi- iqn.1997-05.com.amazon:myvolume-lun-0 -> ../../sda We highly recommend that after you set up your initiator you customize your iSCSI settings as discussed in Customizing Your Linux iSCSI Settings. Initializing and formatting your volume After you use the iSCSI initiator in your client to connect to your volumes, you initialize and format your volume. Initializing and formatting your volume API Version 2013-06-30 59 AWS Storage Gateway Topics Volume Gateway User Guide • Initializing and formatting your volume on Microsoft Windows • Initializing and formatting your volume on Red Hat Enterprise Linux Initializing and formatting your volume on Microsoft Windows Use the following procedure to initialize and format your volume on Windows. To initialize and format your storage volume 1. 2. Start diskmgmt.msc to open the Disk Management console. In the Initialize Disk dialog box, initialize the volume as a MBR (Master Boot Record) partition. When selecting the partition style, you should take into account the type of volume you are connecting to—cached or stored—as shown in the following table. Partition Style Use in the Following Conditions MBR (Master Boot Record) • If your gateway is a stored volume and the storage volume is limited to 1 TiB in size. • If your gateway is a cached volume and the storage volume is less than 2 TiB in size. GPT (GUID Partition Table) If your gateway's storage volume is 2 TiB or greater in size. 3. Create a simple volume: a. Bring the volume online to initialize it. All the available volumes are displayed in the disk management console. b. Open the context (right-click) menu for the disk, and then choose New Simple Volume. Important Be careful not to format the wrong disk. Check to make sure that the disk you are formatting matches the size of the local disk you allocated to the gateway VM and that it has a status of Unallocated. Initializing and formatting on Windows API Version 2013-06-30 60 AWS Storage Gateway Volume Gateway User Guide c. Specify the maximum disk size. d. Assign a drive letter or path to your volume, and format the volume by choosing Perform a quick format. Important We strongly recommend using Perform a quick format for cached volumes. Doing so results in less initialization I/O, smaller initial snapshot size, and the fastest time to a usable volume. It also avoids using cached volume space for the full format process. Note The time that it takes to format the volume depends on the size of the volume. The process might take several minutes to complete. Initializing and formatting your volume on Red Hat Enterprise Linux Use the following procedure to initialize and format your volume on Red Hat Enterprise Linux (RHEL). To initialize and format your storage volume 1. Change directory to the /dev folder. 2. Run the sudo cfdisk command. 3. Identify your new volume by using the following command. To ﬁnd new volumes, you can list the partition layout of your volumes. $ lsblk An "unrecognized volumes
storagegateway-vgw-ug-024	storagegateway-vgw-ug.pdf	24	process. Note The time that it takes to format the volume depends on the size of the volume. The process might take several minutes to complete. Initializing and formatting your volume on Red Hat Enterprise Linux Use the following procedure to initialize and format your volume on Red Hat Enterprise Linux (RHEL). To initialize and format your storage volume 1. Change directory to the /dev folder. 2. Run the sudo cfdisk command. 3. Identify your new volume by using the following command. To ﬁnd new volumes, you can list the partition layout of your volumes. $ lsblk An "unrecognized volumes label" error for the new unpartitioned volume appears. 4. Initialize your new volume. When selecting the partition style, you should take into account the size and type of volume you are connecting to—cached or stored—as shown in the following table. Initializing and formatting on RHEL API Version 2013-06-30 61 AWS Storage Gateway Volume Gateway User Guide Partition Style Use in the Following Conditions MBR (Master Boot Record) • If your gateway is a stored volume and the storage volume is limited to 1 TiB in size. • If your gateway is a cached volume and the storage volume is less than 2 TiB in size. GPT (GUID Partition Table) If your gateway's storage volume is 2 TiB or greater in size. For an MBR partition, use the following command: sudo parted /dev/your volume mklabel msdos For a GPT partition, use the following command: sudo parted /dev/your volume mklabel gpt 5. Create a partition by using the following command. sudo parted -a opt /dev/your volume mkpart primary file system 0% 100% 6. Assign a drive letter to the partition and create a ﬁle system by using the following command. sudo mkfs -L datapartition /dev/your volume 7. Mount the ﬁle system by using the following command. sudo mount -o defaults /dev/your volume /mnt/your directory Testing your gateway You test your Volume Gateway setup by performing the following tasks: 1. Write data to the volume. 2. Take a snapshot. 3. Restore the snapshot to another volume. Testing your gateway API Version 2013-06-30 62 AWS Storage Gateway Volume Gateway User Guide You verify the setup for a gateway by taking a snapshot backup of your volume and storing the snapshot in AWS. You then restore the snapshot to a new volume. Your gateway copies the data from the speciﬁed snapshot in AWS to the new volume. Note Restoring data from Amazon Elastic Block Store (Amazon EBS) volumes that are encrypted is not supported. To create an Amazon EBS snapshot of a storage volume on Microsoft Windows 1. On your Windows computer, copy some data to your mapped storage volume. The amount of data copied doesn't matter for this demonstration. A small ﬁle is enough to demonstrate the restore process. 2. In the navigation pane of the Storage Gateway console, choose Volumes. 3. Choose the storage volume that you created for the gateway. This gateway should have only one storage volume. Choose the volume displays its properties. 4. For Actions, choose Create EBS snapshot to create a snapshot of the volume. Depending on the amount of data on the disk and the upload bandwidth, it might take a few seconds to complete the snapshot. Note the volume ID for the volume from which you create a snapshot. You use the ID to ﬁnd the snapshot. 5. 6. In the Create EBS Snapshot dialog box, provide a description for your snapshot. (Optional) For Tags, enter a key and value to add tags to the snapshot. A tag is a case-sensitive key-value pair that helps you manage, ﬁlter, and search for your snapshots. 7. Choose Create Snapshot. Your snapshot is stored as an Amazon EBS snapshot. Note your snapshot ID. The number of snapshots created for your volume is displayed in the snapshot column. 8. In the EBS snapshots column, choose the link for the volume that you created the snapshot for to see your EBS snapshot on the Amazon EC2 console. To restore a snapshot to another volume See Creating a storage volume. Testing your gateway API Version 2013-06-30 63 AWS Storage Gateway Volume Gateway User Guide Backing up your volumes By using Storage Gateway, you can help protect your on-premises business applications that use Storage Gateway volumes for cloud-backed storage. You can back up your on-premises Storage Gateway volumes using the native snapshot scheduler in Storage Gateway or AWS Backup. In both cases, Storage Gateway volume backups are stored as Amazon EBS snapshots in Amazon Web Services. Topics • Using Storage Gateway to back up your volumes • Using AWS Backup to back up your volumes Using Storage Gateway to back up your volumes You can use the Storage Gateway Management Console to back up your volumes by taking Amazon EBS snapshots and storing the
storagegateway-vgw-ug-025	storagegateway-vgw-ug.pdf	25	can help protect your on-premises business applications that use Storage Gateway volumes for cloud-backed storage. You can back up your on-premises Storage Gateway volumes using the native snapshot scheduler in Storage Gateway or AWS Backup. In both cases, Storage Gateway volume backups are stored as Amazon EBS snapshots in Amazon Web Services. Topics • Using Storage Gateway to back up your volumes • Using AWS Backup to back up your volumes Using Storage Gateway to back up your volumes You can use the Storage Gateway Management Console to back up your volumes by taking Amazon EBS snapshots and storing the snapshots in Amazon Web Services. You can either take a one-time snapshot or set up a snapshot schedule that is managed by Storage Gateway. You can later restore the snapshot to a new volume by using the Storage Gateway console. For information about how to back up and manage your backup from the Storage Gateway, see the following topics: • Testing your gateway • Creating a recovery snapshot • Cloning a cached volume from a recovery point Using AWS Backup to back up your volumes AWS Backup is a centralized backup service that makes it easy and cost-eﬀective for you to back up your application data across AWS services in both the Amazon Web Services Cloud and on-premises. Doing this helps you meet your business and regulatory backup compliance requirements. AWS Backup makes protecting your AWS storage volumes, databases, and ﬁle systems simple by providing a central place where you can do the following: • Conﬁgure and audit the AWS resources that you want to back up. • Automate backup scheduling. • Set retention policies. • Monitor all recent backup and restore activity. Backing up your volumes API Version 2013-06-30 64 AWS Storage Gateway Volume Gateway User Guide Because Storage Gateway integrates with AWS Backup, it lets customers use AWS Backup to back up on-premises business applications that use Storage Gateway volumes for cloud-backed storage. AWS Backup supports backup and restore of both cached and stored volumes. For information about AWS Backup, see the AWS Backup documentation. For information about AWS Backup, see What is AWS Backup? in the AWS Backup User Guide. You can manage Storage Gateway volumes' backup and recovery operations with AWS Backup and avoid the need to create custom scripts or manually manage point-in-time backups. With AWS Backup, you can also monitor your on-premises volume backups alongside your in-cloud AWS resources from a single AWS Backup dashboard. You can use AWS Backup to either create a one- time on-demand backup or deﬁne a backup plan that is managed in AWS Backup. Storage Gateway volume backups taken from AWS Backup are stored in Amazon S3 as Amazon EBS snapshots. You can see the Storage Gateway volume backups from the AWS Backup console or the Amazon EBS console. You can easily restore Storage Gateway volumes that are managed through AWS Backup to any on-premises gateway or in-cloud gateway. You can also restore such a volume to an Amazon EBS volume that you can use with Amazon EC2 instances. Beneﬁts of Using AWS Backup to Back Up Storage Gateway Volumes The beneﬁts of using AWS Backup to back up Storage Gateway volumes are that you can meet compliance requirements, avoid operational burden, and centralize backup management. AWS Backup allows you to do the following: • Set customizable scheduled backup policies that meet your backup requirements. • Set backup retention and expiration rules so you no longer need to develop custom scripts or manually manage the point-in-time backups of your volumes. • Manage and monitor backups across multiple gateways, and other AWS resources from a central view. To use AWS Backup to create backups of your volumes Note AWS Backup requires that you choose an AWS Identity and Access Management (IAM) role that AWS Backup consumes. You need to create this role because AWS Backup doesn't create it for you. You also need to create a trust relationship between AWS Backup and Using AWS Backup to back up your volumes API Version 2013-06-30 65 AWS Storage Gateway Volume Gateway User Guide this IAM role. For information about how to do this, see the AWS Backup User Guide. For information about how to do this, see Creating a Backup Plan in the AWS Backup User Guide. 1. Open the Storage Gateway console and choose Volumes from the navigation pane at left. 2. For Actions, choose Create on-demand backup with AWS Backup or Create AWS backup plan. If you want to create an on-demand backup of the Storage Gateway volume, choose Create on-demand backup with AWS Backup. You are directed the AWS Backup console. If you want to create a new AWS Backup plan, choose Create AWS backup plan. You are directed to the AWS Backup console. On the AWS Backup console,
storagegateway-vgw-ug-026	storagegateway-vgw-ug.pdf	26	how to do this, see Creating a Backup Plan in the AWS Backup User Guide. 1. Open the Storage Gateway console and choose Volumes from the navigation pane at left. 2. For Actions, choose Create on-demand backup with AWS Backup or Create AWS backup plan. If you want to create an on-demand backup of the Storage Gateway volume, choose Create on-demand backup with AWS Backup. You are directed the AWS Backup console. If you want to create a new AWS Backup plan, choose Create AWS backup plan. You are directed to the AWS Backup console. On the AWS Backup console, you can create a backup plan, assign a Storage Gateway volume to the backup plan, and create a backup. You can also do ongoing backup management tasks. Finding and restoring your volumes from AWS Backup You can ﬁnd and restore your backup Storage Gateway volumes from the AWS Backup console. For more information, see the AWS Backup User Guide. For more information, see Recovery Points in the AWS Backup User Guide. To ﬁnd and restore your volumes 1. Open the AWS Backup console and ﬁnd the Storage Gateway volume backup that you want to restore. You can restore the Storage Gateway volume backup to an Amazon EBS volume or to a Storage Gateway volume. Choose the appropriate option for your restore requirements. 2. For Restore type, choose to restore a stored or cached Storage Gateway volume and provide the required information: • For a stored volume, provide the information for Gateway name, Disk ID, and iSCSI target name. • For a cached volume, provide the information for Gateway name, Capacity, and iSCSI target name. 3. Choose Restore resource to restore your volume. Using AWS Backup to back up your volumes API Version 2013-06-30 66 AWS Storage Gateway Note Volume Gateway User Guide You can't use the Amazon EBS console to delete a snapshot that is created by AWS Backup. Where do I go from here? In the preceding sections, you created and provisioned a gateway and then connected your host to the gateway's storage volume. You added data to the gateway's iSCSI volume, took a snapshot of the volume, and restored it to a new volume, connected to the new volume, and veriﬁed that the data shows up on it. After you ﬁnish the exercise, consider the following: • If you plan on continuing to use your gateway, read about sizing the upload buﬀer more appropriately for real-world workloads. For more information, see Sizing Your Volume Gateway's Storage for Real-World Workloads. Other sections of this guide include information about how to do the following: • To learn more about storage volumes and how to manage them, see Managing Your Volume Gateway. • If you don't plan on continuing to use your gateway, consider deleting the gateway to avoid incurring any charges. For more information, see Cleaning up unnecessary resources. • To troubleshoot gateway problems, see Troubleshooting your gateway. • To optimize your gateway, see Optimizing gateway performance. • To learn about Storage Gateway metrics and how you can monitor how your gateway performs, see Monitoring Storage Gateway. • To learn more about conﬁguring your gateway's iSCSI targets to store data, see Connecting to your volumes from a Windows client. To learn about sizing your Volume Gateway's storage for real-world workloads and cleaning up resources you don't need, see the following sections. Where do I go from here? API Version 2013-06-30 67 AWS Storage Gateway Volume Gateway User Guide Sizing Your Volume Gateway's Storage for Real-World Workloads By this point, you have a simple, working gateway. However, the assumptions used to create this gateway are not appropriate for real-world workloads. If you want to use this gateway for real- world workloads, you need to do two things: 1. Size your upload buﬀer appropriately. 2. Set up monitoring for your upload buﬀer, if you haven't done so already. Following, you can ﬁnd how to do both of these tasks. If you activated a gateway for cached volumes, you also need to size your cache storage for real-world workloads. To size your upload buﬀer and cache storage for a gateway-cached setup • Use the formula shown in Determining the size of upload buﬀer to allocate for sizing the upload buﬀer. We strongly recommend that you allocate at least 150 GiB for the upload buﬀer. If the upload buﬀer formula yields a value less than 150 GiB, use 150 GiB as your allocated upload buﬀer. The upload buﬀer formula takes into account the diﬀerence between throughput from your application to your gateway and throughput from your gateway to AWS, multiplied by how long you expect to write data. For example, assume that your applications write text data to your gateway at a rate of 40 MB per second for 12 hours a day and
storagegateway-vgw-ug-027	storagegateway-vgw-ug.pdf	27	to allocate for sizing the upload buﬀer. We strongly recommend that you allocate at least 150 GiB for the upload buﬀer. If the upload buﬀer formula yields a value less than 150 GiB, use 150 GiB as your allocated upload buﬀer. The upload buﬀer formula takes into account the diﬀerence between throughput from your application to your gateway and throughput from your gateway to AWS, multiplied by how long you expect to write data. For example, assume that your applications write text data to your gateway at a rate of 40 MB per second for 12 hours a day and your network throughput is 12 MB per second. Assuming a compression factor of 2:1 for the text data, the formula speciﬁes that you need to allocate approximately 675 GiB of upload buﬀer space. To size your upload buﬀer for a stored setup • Use the formula discussed in Determining the size of upload buﬀer to allocate. We strongly recommend that you allocate at least 150 GiB for your upload buﬀer. If the upload buﬀer formula yields a value less than 150 GiB, use 150 GiB as your allocated upload buﬀer. The upload buﬀer formula takes into account the diﬀerence between throughput from your application to your gateway and throughput from your gateway to AWS, multiplied by how long you expect to write data. For example, assume that your applications write text data to your gateway at a rate of 40 MB per second for 12 hours a day and your network throughput is 12 MB per second. Assuming a compression factor of 2:1 for the text data, the formula speciﬁes that you need to allocate approximately 675 GiB of upload buﬀer space. Sizing Your Volume Gateway's Storage for Real-World Workloads API Version 2013-06-30 68 AWS Storage Gateway Volume Gateway User Guide To monitor your upload buﬀer 1. Open the Storage Gateway console at https://console.aws.amazon.com/storagegateway/ home. 2. Choose the Gateway tab, choose the Details tab, and then ﬁnd the Upload Buﬀer Used ﬁeld to view your gateway's current upload buﬀer. 3. Set one or more alarms to notify you about upload buﬀer use. We highly recommend that you create one or more upload buﬀer alarms in the Amazon CloudWatch console. For example, you can set an alarm for a level of use you want to be warned about and an alarm for a level of use that, if exceeded, is cause for action. The action might be adding more upload buﬀer space. For more information, see To set an upper threshold alarm for a gateway's upload buﬀer. 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 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 Volume 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 Activating your gateway in a virtual private cloud API Version 2013-06-30 69 AWS Storage Gateway Volume Gateway User Guide 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 • TCP 1026 • TCP 1027 • TCP 1028 • TCP 1031 • TCP 2222 8. Choose Create
storagegateway-vgw-ug-028	storagegateway-vgw-ug.pdf	28	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 • 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 ﬁrst 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 Creating a VPC endpoint for Storage Gateway API Version 2013-06-30 70 AWS Storage Gateway Volume Gateway User Guide 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 71 AWS Storage Gateway Volume Gateway User Guide Managing Your Volume Gateway Managing your gateway includes tasks such as conﬁguring cache storage and upload buﬀer space, working with volumes, and doing general maintenance. If you haven't created a gateway, see Getting started with AWS Storage Gateway. Cached volumes are volumes in Amazon Simple Storage Service (Amazon S3) that are exposed as iSCSI targets on which you can store your application data. You can ﬁnd information following about how to add and delete volumes for your cached setup. You can also learn how to add and remove Amazon Elastic Block Store (Amazon EBS) volumes in Amazon EC2 gateways. Important If a cached volume keeps your primary data in Amazon S3, you should avoid processes that read or write all data on the entire volume. For example, we don't recommend using virus-scanning software that scans the entire cached volume. Such a scan, whether done on demand or scheduled, causes all data stored in Amazon S3 to be downloaded locally for scanning, which results in high bandwidth usage. Instead of doing a full disk scan, you can use real-time virus scanning—that is, scanning data as it is read from or written to the cached volume. Resizing a volume is not supported. To change the size of a volume, create a snapshot of the volume, and then create a new cached volume from the snapshot. The new volume can be bigger than the volume from which the snapshot was created. For steps describing how to remove a volume, see To delete a volume. For steps describing how to add a volume and preserve existing data, see Deleting storage volumes. All cached volume data and snapshot data is stored in Amazon S3 and is encrypted at rest using server-side encryption (SSE). However, you cannot access this data by using the Amazon S3 API or other tools such as the Amazon S3 Management Console. Following, you can ﬁnd information about how to manage your Volume 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. API Version 2013-06-30 72 AWS Storage Gateway Volume Gateway User Guide • Adding and expanding volumes - Learn how to add more volumes to your gateway, or expand the size of existing volumes as your application needs grow. • Cloning a cached volume from a recovery point - Learn how to create a new volume from an existing volume's recovery point, which is a saved point in time when all of the data on the volume is consistent. • Viewing volume usage - Learn how to view the amount of data stored on a volume by using the Storage Gateway console. • Deleting storage volumes - Learn how to delete a volume if your application needs change, such as if you migrate an application to use a larger storage volume. • Moving Your Volumes to a Diﬀerent Gateway - Learn how to detach and reattach volumes, which is useful if you need to move your volumes to a diﬀerent Volume Gateway as your performance needs change. • Creating a recovery snapshot - Learn how to create a recovery snapshot from a volume recovery point for a gateway, and where to ﬁnd that snapshot in the Storage Gateway console after you create it. • Editing a snapshot schedule - Learn how to customize a snapshot schedule by changing

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.