View Source AWS.BackupGateway (aws-elixir v0.13.1)

Backup gateway

Backup gateway connects Backup to your hypervisor, so you can create, store, and restore backups of your virtual machines (VMs) anywhere, whether on-premises or in the VMware Cloud (VMC) on Amazon Web Services.

Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.

Use Backup to assign virtual or on-premises resources to a backup plan, or run on-demand backups. Once you have backed up your resources, you can view them and restore them like any resource supported by Backup.

To download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways, then choose Create gateway.

Link to this section Summary

Functions

Associates a backup gateway with your server.

Disassociates a backup gateway from the specified server.

By providing the ARN (Amazon Resource Name), this API returns the gateway.

Connect to a hypervisor by importing its configuration.

Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.

Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

Set the maintenance start time for a gateway.

Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

Removes tags from the resource.

Updates the gateway virtual machine (VM) software.

Updates a hypervisor metadata, including its host, username, and password.

Link to this section Functions

Link to this function

associate_gateway_to_server(client, input, options \\ [])

View Source

Associates a backup gateway with your server.

After you complete the association process, you can back up and restore your VMs through the gateway.

Link to this function

create_gateway(client, input, options \\ [])

View Source

Creates a backup gateway.

After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.

Link to this function

delete_gateway(client, input, options \\ [])

View Source

Deletes a backup gateway.

Link to this function

delete_hypervisor(client, input, options \\ [])

View Source

Deletes a hypervisor.

Link to this function

disassociate_gateway_from_server(client, input, options \\ [])

View Source

Disassociates a backup gateway from the specified server.

After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.

Link to this function

get_gateway(client, input, options \\ [])

View Source

By providing the ARN (Amazon Resource Name), this API returns the gateway.

Link to this function

import_hypervisor_configuration(client, input, options \\ [])

View Source

Connect to a hypervisor by importing its configuration.

Link to this function

list_gateways(client, input, options \\ [])

View Source

Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.

The returned list is ordered by gateway Amazon Resource Name (ARN).

Link to this function

list_hypervisors(client, input, options \\ [])

View Source

Lists your hypervisors.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

Link to this function

list_virtual_machines(client, input, options \\ [])

View Source

Lists your virtual machines.

Link to this function

put_maintenance_start_time(client, input, options \\ [])

View Source

Set the maintenance start time for a gateway.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Tag the resource.

Link to this function

test_hypervisor_configuration(client, input, options \\ [])

View Source

Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes tags from the resource.

Link to this function

update_gateway_information(client, input, options \\ [])

View Source

Updates a gateway's name.

Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.

Link to this function

update_gateway_software_now(client, input, options \\ [])

View Source

Updates the gateway virtual machine (VM) software.

The request immediately triggers the software update.

When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete.

Link to this function

update_hypervisor(client, input, options \\ [])

View Source

Updates a hypervisor metadata, including its host, username, and password.

Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request.