NetBackup Marketplace Deployment on AWS
NetBackup Marketplace Deployment on AWS
Deployment on AWS
Release 10.4
NetBackup™ Marketplace Deployment on AWS
Last updated: 2024-03-26
Legal Notice
Copyright © 2024 Veritas Technologies LLC. All rights reserved.
Veritas, the Veritas Logo, Veritas Alta, and NetBackup are trademarks or registered trademarks
of Veritas Technologies LLC or its affiliates in the U.S. and other countries. Other names may
be trademarks of their respective owners.
This product may contain third-party software for which Veritas is required to provide attribution
to the third party (“Third-party Programs”). Some of the Third-party Programs are available
under open source or free software licenses. The License Agreement accompanying the
Software does not alter any rights or obligations you may have under those open source or
free software licenses. Refer to the Third-party Legal Notices document accompanying this
Veritas product or available at:
https://www.veritas.com/about/legal/license-agreements
The product described in this document is distributed under licenses restricting its use, copying,
distribution, and decompilation/reverse engineering. No part of this document may be
reproduced in any form by any means without prior written authorization of Veritas Technologies
LLC and its licensors, if any.
The Licensed Software and Documentation are deemed to be commercial computer software
as defined in FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19
"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, et seq.
"Commercial Computer Software and Commercial Computer Software Documentation," as
applicable, and any successor regulations, whether delivered by Veritas as on premises or
hosted services. Any use, modification, reproduction release, performance, display or disclosure
of the Licensed Software and Documentation by the U.S. Government shall be solely in
accordance with the terms of this Agreement.
http://www.veritas.com
Technical Support
Technical Support maintains support centers globally. All support services will be delivered
in accordance with your support agreement and the then-current enterprise technical support
policies. For information about our support offerings and how to contact Technical Support,
visit our website:
https://www.veritas.com/support
You can manage your Veritas account information at the following URL:
https://my.veritas.com
If you have questions regarding an existing support agreement, please email the support
agreement administration team for your region as follows:
Japan [email protected]
Documentation
Make sure that you have the current version of the documentation. Each document displays
the date of the last update on page 2. The latest documentation is available on the Veritas
website:
https://sort.veritas.com/documents
Documentation feedback
Your feedback is important to us. Suggest improvements or report errors or omissions to the
documentation. Include the document title, document version, chapter title, and section title
of the text on which you are reporting. Send feedback to:
You can also see documentation information or ask a question on the Veritas community site:
http://www.veritas.com/community/
https://sort.veritas.com/data/support/SORT_Data_Sheet.pdf
Contents
Troubleshooting ........................................................................... 47
Deployment Logs ......................................................................... 48
Chapter 1
NetBackup marketplace
deployment on AWS
This chapter includes the following topics:
■ Network configuration
■ Proxy settings for Snapshot Manager server: You can configure the Snapshot
Manager component to be accessible through a proxy server, if required.
■ Other mandatory specifications such as AWS instance, the virtual environment
and network, and the server-specific configuration details.
Note: The NetBackup is deployed with 60 day evaluation license by default. After
successful installation of the NetBackup, connect to the web UI to add the production
license. If the license is not added within 60 days, NetBackup may stop working.
This document provides the instructions for deploying Veritas NetBackup on the
AWS cloud by using a CloudFormation template. The intended audience for this
document includes backup administrators, cloud administrators, architects, and
system administrators.
4. For Primary Server deployment, you need to have an existing IAM role. For
permissions required for the IAM role, refer see See “IAM role required for the
primary server” on page 19.
5. 5. For Cloud Recovery Server deployment, you need to have an existing IAM
role. For permissions required for the IAM role, refer See “IAM role required
for Cloud Recovery Server” on page 22.
6. Note: for the primary server deployment, IAM Role can be deleted after
successful deployment.
Network configuration
The NetBackup instances need access to the public Internet for the product to
function. If you are deploying NetBackup components in an existing VPC ensure
that the subnet used to deploy the NetBackup instances has outbound access to
the Internet, either through an internet gateway or a NAT gateway.
If you do not have a properly configured VPC available, you can choose to create
a new one during the deployment. The VPC will be created with a public and a
private subnet. The NetBackup primary server will be deployed in the public subnet
so that you can access the NetBackup UI from a machine outside the VPC.
NetBackup Media servers can be deployed in the private subnet for greater security.
Chapter 2
Deploying NetBackup on
AWS Cloud using the
marketplace offer
This chapter includes the following topics:
6 Select the version and select the region in which you want to deploy the
component.
7 On the Launch this software page that opens, select Launch CloudFormation
under Choose Action to begin configuration using the AWS CloudFormation
console.
8 This opens the Create Stack page where the template URL is pre-populated
for you. Click Next.
9 Then on the Specify stack details page that opens, specify a name for the
stack (deployment) and provide the configuration details.
Refer to the individual configuration sections that correspond to the delivery
method you selected.
10 On the next page, for Configure stack option, change the Stack failure
options to preserve the successfully provisioned resources. This helps in
preserving the created resources and troubleshoot issues in case of stack
failure.
Chapter 3
Deployment options
(Delivery methods) for
NetBackup on AWS cloud
This chapter includes the following topics:
Note: For deploying CRS server, choose the delivery method as NetBackup Primary
Server (CRS optional).
Deployment options (Delivery methods) for NetBackup on AWS cloud 14
Option 4: Cloud Recovery server only
Steps to configure:
1 Provide a name for the Stack.
2 Provide the various configuration details for NetBackup Cloud Recovery server
instance, VPC and subnet, installation parameters etc.
See “NetBackup installation parameters for Cloud Recovery server” on page 20.
3 Click Next to tag your stack for identification.
4 Review all the details and initiate the launch.
Chapter 4
NetBackup configuration
parameters
This chapter includes the following topics:
Parameters Description
NetBackup server Instance Type Select a supported instance type from the
drop-down list, based on the size of your
deployment.
NetBackup Installation Volume Size Specify the storage space that should be
assigned to NetBackup, based on the size of
your deployment.
Parameters Description
Parameters Description
Create New DHCP Option Set for this VPC? Select True only if you want the deployment
to create a new DHCP Option set for your
VPC. Select False if you already have a
DHCP Option set associated with your VPC
that can resolve Route 53 host names using
an Amazon provided DNS server. Selecting
True will override any existing DHCP options
associated with the VPC.
NetBackup server Domain Name Route53 DNS is configured with this domain
name and a Record is updated in the
corresponding Hosted Zone with the private
IP of the NetBackup server.
Is there an Existing Hosted Zone for this Select True if a Route53 Hosted Zone
Domain? associated with the selected VPC already
exists for the domain name entered above.
Select False to create a new Hosted Zone
along with the deployment.
Parameters Description
New VPC CIDR Block Specify the CIDR block that will be used to
create the new VPC and security group rules
for the new server. Ex. 172.31.0.0/16
CIDR Block for Public Subnet Select the CIDR block within the VPC CIDR
block that will be used for the public subnet
created in the VPC. Ex. 172.31.0.0/24
NetBackup configuration parameters 18
NetBackup installation parameters for the primary server
Parameters Description
CIDR Block for Private Subnet Select the CIDR block within the VPC CIDR
block that will be used for the private subnet
created in the VPC. Ex. 172.31.1.0/24
NetBackup server Domain Name A Route53 Hosted Zone for this domain name
will be created. Then a DNS is configured
with this domain name and a Record is
updated in the Hosted Zone with the private
IP of the NetBackup server.
Note: : If you have selected a new VPC and subnet configuration to be created,
you still need to provide a VPC ID and Subnet ID in the section 'VPC and Subnet
details for deployment in existing VPC' above. This is because, AWS does not
permit these fields to be blank. Any values you provide in these fields will be ignored
if you have selected to create a new VPC and subnet.
Parameters Description
NetBackup Web User Password Password must be at least 8 characters long which
includes a number, a lower case, an upper case and a
special character (!@#$%^&*).
Confirm NetBackup Web User Password must be at least 8 characters long which
Password includes a number, a lower case, an upper case and a
special character (!@#$%^&*).
NetBackup configuration parameters 19
NetBackup installation parameters for the primary server
Parameters Description
NetBackup Server Name Provide a name for the NetBackup server. Must be a valid
name with a minimum length of 8 characters and it should
not start with minus sign (-), dot (.) and a number.
User for Services on NetBackup Provide a non-root Service Username. It is used to run
Server NetBackup services and is set as database user as well.
It will not be accessible via SSH. Most services on the
server run as this user. User gets created and gets
associated with the 'nbwebgrp' user group as the
secondary group.
Table 4-5 Permission of IAM role required for the primary server
Action Resource
■ secretsmanager:GetResourcePolicy *
■ secretsmanager:GetSecretValue
■ secretsmanager:DescribeSecret
■ secretsmanager:DeleteSecret
■ secretsmanager:ListSecretVersionIds
Note: Refer IAMRoleCreation and IAMPolicyCreation for creating IAM role and
policies.
NetBackup configuration parameters 20
NetBackup installation parameters for Media server
Parameters Description
Primary server Name Provide the name of a NetBackup primary server to which
the media server should connect. The primary server needs
to have been deployed in the same domain and the VPC,
where you are trying to deploy the media server.
NetBackup Service Username Provide a Service Username. Most services on the server
on Media Server will run as this user. If a non-root username is provided,
then the user will be created. Refer to the Running
NetBackup services with non-privileged user (service user)
account chapter in the NetBackup Security and Encryption
Guide.
NetBackup Token Enter the NetBackup authorization token key for the media
server generated from an existing the primary server. Refer
to the NetBackup Security and Encryption Guide.
Parameters Description
Parameters Description
NetBackup server Instance Type Select the instance type for the NetBackup
server from the dropdown list.
SSH Key Pair Select an existing EC2 Key Pair in the region,
to enable SSH access to the instance.
NetBackup Installation Volume Size Specify the storage space that should be
assigned to NetBackup, based on the size of
your deployment. For the Cloud Recovery
server the volume size must be minimum 200
GB
Use an Existing VPC? Select True if you want to deploy the Cloud
Recovery server into an existing VPC. Select
False to deploy the Cloud Recovery server
in a new VPC that will be created during the
deployment.
See “VPC and Subnet details for deployment in existing VPC” on page 16.
VPC and Subnet configuration for deployment in new VPC (Required only if new VPC
has been selected above)
See “VPC and Subnet configuration for deployment in new VPC” on page 17.
Note: If you have selected a new VPC and subnet configuration to be created, you still
need to provide a VPC ID and Subnet ID in the section 'VPC and Subnet details for
deployment in existing VPC' above. This is because, AWS does not permit these fields to
be blank. Any values you provide in these fields will be ignored if you have selected to create
a new VPC and subnet.
IAM Role Name Name of existing IAM role for Cloud Recovery
server. The role must have all required
permissions.See “IAM role required for Cloud
Recovery Server” on page 22.
NetBackup Server Name Provide a name for the Primary server. Must
be a valid name with a minimum length of 8
characters and it should not start with minus
sign (-), dot (.) and a number.
NetBackup configuration parameters 22
NetBackup installation parameters for Cloud Recovery server
Parameters Description
■ ec2:CreateTags *
■ ec2:DescribeImportImageTasks
■ ec2:ImportImage
■ ec2:DescribeImages
■ iam:ListRolePolicies
■ iam:ListRoles
■ iam:GetRole
■ iam:GetRolePolicy
■ iam:CreateRole
■ iam:PutRolePolicy
■ s3:ListAllMyBuckets
NetBackup configuration parameters 23
NetBackup installation parameters for Cloud Recovery server
Note: Refer IAMRoleCreation and IAMPolicyCreation for creating IAM role and
policies.
Chapter 5
Deploying Snapshot
Manager
This chapter includes the following topics:
■ Select the Access type. This value determines how AWS accesses the
permission policy. (This example uses Programmatic access).
■ Select Next: Permissions.
■ On the Set permissions for username screen, select Attach existing
policies directly.
■ Select the previously created permission policy (shown below) and
select Next: Review.
■ On the Permissions summary page, select Create user.
■ Obtain the Access Key and Secret Key for the newly created user.
3 To configure the AWS plug-in for the created or edited user, refer to the plug-in
configuration notes.
Resource Description
Resource Description
■ SSH on port 22
■ RabbitMQ on port 5671
■ HTTPS on port 443
Resource Description
replace the instance, for example in cases where you want to stop the instance for
maintenance purposes.
For more information on how the Amazon EC2 Auto Scaling works, refer to the
following Amazon AWS documentation:
Health checks for Auto Scaling instances
Parameters Description
OS type for EC2 Instance Select the OS type for the Snapshot Manager
instance.
EC2 Instance Type Select the EC2 instance type that you want
to use for the Snapshot Manager instance.
Volume Size Enter the size (in GB) of the EBS volume that
will be attached to the Snapshot Manager
instance.
Network Configuration
Parameters Description
localhost,mycompany.com,192.168.0.10:80
Snapshot Managerserver name Provide the server name with which you want
to enable the access to Snapshot Manager.
Parameters Description
Security configuration
Parameters Description
EC2Backup Allow *
Deploying Snapshot Manager 35
Deploying Snapshot Manager server using the marketplace offer
■ sts:GetCallerIdentity
■ ec2:CreateSnapshot
■ ec2:DescribeInstances'
■ ec2:DescribeInstanceStatus
■ ec2:ModifySnapshotAttribute
■ ec2:CreateImage
■ ec2:CopyImage
■ ec2:CopySnapshot'
■ ec2:DescribeSnapshots
■ ec2:DescribeVolumeStatus
■ ec2:DescribeVolumes
■ ec2:RegisterImage
■ ec2:DescribeVolumeAttribute
■ ec2:DescribeSubnets
■ ec2:DescribeVpcs
■ ec2:DeregisterImage
■ ec2:DeleteSnapshot
■ ec2:DescribeInstanceAttribute
■ ec2:DescribeRegions
■ ec2:ModifyImageAttribute
■ ec2:DescribeAvailabilityZones
■ ec2:ResetSnapshotAttribute
■ ec2:DescribeHosts
■ ec2:DescribeImages
■ ec2:AssociateAddress
■ ec2:DescribeNetworkInterfaces
■ ec2:DescribeSecurityGroups
■ ec2:AuthorizeSecurityGroupEgress
■ ec2:AuthorizeSecurityGroupIngress
■ ec2:CreateSnapshots
■ ec2:GetEbsEncryptionByDefault
■ ec2:DescribeKeyPairs
■ secretsmanager:GetResourcePolicy
■ secretsmanager:GetSecretValue
■ secretsmanager:DescribeSecret
■ secretsmanager:RestoreSecret
■ secretsmanager:PutSecretValue
■ secretsmanager:DeleteSecret
Deploying Snapshot Manager 36
Deploying Snapshot Manager server using the marketplace offer
■ secretsmanager:UpdateSecret
Endpoints
secretsmanager.*.amazonaws.com
eks.*.amazonaws.com
autoscaling.*.amazonaws.com
ec2.*.amazonaws.com
sts.amazonaws.com
rds.*.amazonaws.com
kms. *.amazonaws.com
ebs.*.amazonaws.com
iam.amazonaws.com
Chapter 6
Encryption enabled
NetBackup primary server
This chapter includes the following topics:
/usr/openv/netbackup/bin/nbkms -createemptydb
/usr/openv/netbackup/bin/nbkms /usr/openv/netbackup/bin/nbkmscmd
-discovernbkms -autodiscover
■ From the list of stacks, click on the Snapshot Manager stack and then
click the Resources tab.
■ From the list of resources displayed, locate a volume of type of
AWS::EC2::Volume and Logical ID as NewVolume. This is the volume
that contains the Snapshot Manager metadata.
■ Copy the entry that appears in the Physical ID column. The entry is of
the format vol-123456abc789 and it represents the volume ID.
#flexsnap_configure
The Snapshot Manager containers are stopped one by one. Messages similar
to the following appear on the command line:
Stopping the services
■ Network Configuration
Upgrade NetBackup Snapshot Manager from AWS Marketplace 45
Upgrade Snapshot Manager deployment using new AWS CloudFormation stack
Perform the following steps before you proceed with the upgrade:
1 Check for the status of the CloudFormation stack created.
2 Delete the stack created by the previous deployment.
3 After the stack creation is successful, perform any one of the action from the
below:
■ a. If the hostname of the Snapshot Manager server remains same, enable
the Snapshot Manager server from the NetBackup primary server.
■ b. If the hostname of the Snapshot Manager server is changed, you will
have to upgrade the NetBackup to the latest version and then again add
the Snapshot Manager to the upgraded NetBackup primary server.
Chapter 9
Troubleshooting section
This chapter includes the following topics:
■ Troubleshooting
■ Deployment Logs
Troubleshooting
1. Unable to login with 'NetBackup Web Username' provided in while
deploying the primary server.
Steps to resolve the issue:
■ Edit the security group of the NetBackup server to allow SSH access on port
22. Make sure you only allow access from the trusted sources in your network.
■ Go to the Output section in the CloudFormation Stack and note down the
NetBackup server private/public IP.
■ SSH connect to the NetBackup server using the username for the ec2-user,
and the PEM file corresponding to the key pair selected during deployment.
■ Use the command sudo passwd root to set a password for the root user.
■ Use the root user and password to log on to the NetBackup console (Java or
Remote Administration Console).
■ Launch the NetBackup Web UI using https://<primaryserver>/webui/login.
Deployment Logs
The NetBackup installation logs can be found at /root/NBSetup/userdata.logon
the appliance.
.
The NetBackup installation logs can be found at /root/NBSetup/userdata.log
on the appliance. While installation going on, one can SSH to the server with
ec2-user and check the logs using command tail -f /var/log/userdata.log.