Veeam Service Provider Console 8.1
REST API Reference
Related documents
Search

AWS Integration

This section describes how you can create an AWS account and create an AWS backup appliance or connect an existing one.

Create AWS Account

To create an AWS account:

  1. Obtain UID of a Veeam Cloud Connect site for which you want to configure integration by sending the GetSites request.
  2. Create a new AWS account by sending the CreatePublicCloudAwsAccount request:
  • Provide the UID you obtained at step 1 as the siteUid parameter value.
  • Provide public and secret key as the accessKey and secretKey property values.
  • Provide a description for an account as the description property value.
  1. Create new guest OS credentials that will be used to access AWS VMs by sending the CreatePublicCloudGuestOsCredentials request:
  • Provide the serviceProviderAdministrator value for the role property.
  • Provide a user name for an account as the username property value.
  • Provide a description for an account as the description property value.
  • Provide a password for an account as the password property value.
  • Provide the UID you obtained at step 1 as the siteUid property value.

Create New Backup Appliance

To create a new AWS backup appliance:

  1. Obtain UID of a Veeam Cloud Connect site on which you want to register a backup appliance by sending the GetSites request.
  2. Obtain ID of an AWS region where a backup appliance will reside by sending the GetPublicCloudAwsRegions request. Provide the UID you obtained at step 1 as the siteUid parameter value.
  3. Obtain UID of an AWS account that will be used for appliance configuration by sending the GetPublicCloudAwsAccounts request. Provide the UID you obtained at step 1 as the siteUid parameter value.
  4. Obtain ID of an AWS data center where a backup appliance will reside by sending the GetPublicCloudAwsDataCenters request:
  • Provide the UID you obtained at step 1 as the siteUid parameter value.
  • Provide the ID you obtained at step 2 as the regionId parameter value.
  1. Create a new Amazon connection by sending the CreatePublicCloudAwsConnection request:
  • Provide the UID you obtained at step 1 as the siteUid parameter value.
  • Provide the UID you obtained at step 3 as the accountUid parameter value.
  • Provide the ID you obtained at step 4 as the dataCenterId parameter value.
  1. Obtain ID of an AWS network that will provide resources to a backup appliance by sending the GetPublicCloudAwsNetworks request:
  • Provide the UID you obtained at step 1 as the siteUid parameter value.
  • Provide the ID of an Amazon connection that you created at step 5 as the connectionUid parameter value.
  1. Obtain ID of an AWS subnet that will provide resources to a backup appliance by sending the GetPublicCloudAwsSubNetworks request:
  • Provide the UID you obtained at step 1 as the siteUid parameter value.
  • Provide the ID of an Amazon connection that you created at step 5 as the connectionUid parameter value.
  • Provide the ID of an AWS network you obtained at step 6 as the networkId parameter value.
  1. Obtain ID of a security group that will include a backup appliance by sending the GetPublicCloudAwsSecurityGroups request:
  • Provide the UID you obtained at step 1 as the siteUid parameter value.
  • Provide the ID of an Amazon connection that you created at step 5 as the connectionUid parameter value.
  • Provide the ID of an AWS network you obtained at step 6 as the networkId parameter value.
  1. Obtain IP addresses that can be assigned to a backup appliance by sending the GetPublicCloudAwsElasticIpAddresses request:
  • Provide the UID you obtained at step 1 as the siteUid parameter value.
  • Provide the ID of an Amazon connection that you created at step 5 as the connectionUid parameter value.
  1. Obtain IP addresses of a Veeam Cloud Connect site on which you want to register a backup appliance by sending the GetPublicCloudAwsBackupServerIpAddresses request. Provide the UID you obtained at step 1 as the siteUid parameter value.
  2. Obtain UID of guest OS credentials to access a VM on which an appliance will be installed by sending the GetPublicCloudGuestOsCredentials request. Provide the UID you obtained at step 1 as the siteUid parameter value.
  3. Obtain a name of an encryption key pair by sending the GetPublicCloudAwsKeys request:
  • Provide the UID you obtained at step 1 as the siteUid parameter value.
  • Provide the ID of an Amazon connection that you created at step 5 as the connectionUid parameter value.

If you want to create a new key pair, send the CreatePublicCloudAwsKey request:

  • Provide the UID you obtained at step 1 as the siteUid parameter value.
  • Provide the ID of an Amazon connection that you created at step 5 as the connectionUid property value.
  • Provide a name for a key pair as the name property value.
  1. Obtain ID of an AWS instance time zone by sending the GetPublicCloudTimeZones request:
  • Provide the UID you obtained at step 1 as the siteUid parameter value.
  • Provide the AWS value for the publicCloudType parameter.
  1. Create a new backup appliance by sending the CreateNewPublicCloudAwsAppliance request:
  • Provide the UID you obtained at step 1 as the siteUid parameter value.
  • Provide the ID of an Amazon connection that you created at step 5 as the connectionUid property value.
  • Provide the UID you obtained at step 3 as the accountUid property value.
  • Provide the ID you obtained at step 4 as the dataCenterId property value.
  • Provide the ID you obtained at step 2 as the regionId property value.
  • Provide a name for a new EC2 instance as the virtualMachineName property value.
  • Provide a description for a new EC2 instance as the description property value.
  • Provide the ID you obtained at step 6 as the networkId property value.
  • Provide the ID you obtained at step 7 as the subnetId property value.
  • Provide the ID you obtained at step 8 as the securityGroupId property value.
  • Provide one of the IP addresses you obtained at step 9 as the applianceIpAddressId property value.

Alternatively, you can assign a new IP address by sending the newIpAddressType property with the dynamic or static value.

  • Provide the IP addresses you obtained at step 10 as the backupServerIpAddresses property value.
  • Provide the UID you obtained at step 11 as the guestOsCredentialsUid property value.
  • Provide the name of a key pair you obtained at step 12 as the keyPairName property value.
  • Provide the ID you obtained at step 13 as the timeZoneId property value.

Connect Backup Appliance

To connect an existing AWS backup appliance:

  1. Obtain UID of a Veeam Cloud Connect site on which you want to register a backup appliance by sending the GetSites request.
  2. Obtain ID of an AWS region where a backup appliance will reside by sending the GetPublicCloudAwsRegions request. Provide the UID you obtained at step 1 as the siteUid parameter value.
  3. Obtain UID of an AWS account that will be used for appliance configuration by sending the GetPublicCloudAwsAccounts request. Provide the UID you obtained at step 1 as the siteUid parameter value.
  4. Obtain ID of an AWS data center where a backup appliance will reside by sending the GetPublicCloudAwsDataCenters request:
  • Provide the UID you obtained at step 1 as the siteUid parameter value.
  • Provide the ID you obtained at step 2 as the regionId parameter value.
  1. Create a new Amazon connection by sending the CreatePublicCloudAwsConnection request:
  • Provide the UID you obtained at step 1 as the siteUid parameter value.
  • Provide the UID you obtained at step 2 as the accountUid parameter value.
  • Provide the ID you obtained at step 3 as the dataCenterId parameter value.
  1. Obtain ID of a EC2 instance where backup appliance is deployed by sending the GetPublicCloudAwsVirtualMachines request:
  • Provide the UID you obtained at step 1 as the siteUid parameter value.
  • Provide the ID of an Amazon connection that you created at step 5 as the connectionUid parameter value.
  • Provide the ID you obtained at step 4 as the dataCenterId parameter value.
  1. Obtain IP address of an AWS network that provides resources to a backup appliance by sending the GetPublicCloudAwsNetworks request.
  • Provide the UID you obtained at step 1 as the siteUid parameter value.
  • Provide the ID of an Amazon connection that you created at step 5 as the connectionUid parameter value.
  1. Obtain UID of guest OS credentials to access a VM on which an appliance is installed by sending the GetPublicCloudGuestOsCredentials request. Provide the UID you obtained at step 1 as the siteUid parameter value.
  2. Obtain security certificate thumbprint by sending the ValidateExistingPublicCloudAwsApplianceConnection request:
  • Provide the UID you obtained at step 1 as the siteUid parameter value.
  • Provide the ID of an Amazon connection that you created at step 5 as the connectionUid property value.
  • Provide the ID you obtained at step 4 as the dataCenterId property value.
  • Provide the ID you obtained at step 2 as the regionId property value.
  • Provide the UID you obtained at step 3 as the accountUid property value.
  • Provide the ID you obtained at step 6 as the virtualMachineId property value.
  • Provide a description for an EC2 instance as the description property value.
  • Provide the ID you obtained at step 7 as the network property value.
  • Provide the UID you obtained at step 8 as the guestOsCredentialsUid property value.
  1. Connect a backup appliance by sending the AddExistingPublicCloudAwsAppliance request:
  • Provide the UID you obtained at step 1 as the siteUid parameter value.
  • Provide the ID of an Amazon connection that you created at step 5 as the connectionUid property value.
  • Provide the ID you obtained at step 4 as the dataCenterId property value.
  • Provide the ID you obtained at step 2 as the regionId property value.
  • Provide the UID you obtained at step 3 as the accountUid property value.
  • Provide the ID you obtained at step 6 as the virtualMachineId property value.
  • Provide a description for a EC2 instance as the description property value.
  • Provide the ID you obtained at step 7 as the privateNetworkAddress property value.
  • Provide the UID you obtained at step 8 as the guestOsCredentialsUid property value.
  • Provide security certificate thumbprint you obtained at step 9 as the certificateThumbprint property value.

Page updated 11/27/2023

Page content applies to build 8.1.0.21999

View all results across Veeam
Back to document search