aws v0.5.0

View Source aws_backup_gateway (aws v0.5.0)

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

associate_gateway_to_server(Client, Input)

Associates a backup gateway with your server.

associate_gateway_to_server(Client, Input, Options)
create_gateway(Client, Input)

Creates a backup gateway.

create_gateway(Client, Input, Options)
delete_gateway(Client, Input)
Deletes a backup gateway.
delete_gateway(Client, Input, Options)
delete_hypervisor(Client, Input)
Deletes a hypervisor.
delete_hypervisor(Client, Input, Options)
disassociate_gateway_from_server(Client, Input)

Disassociates a backup gateway from the specified server.

disassociate_gateway_from_server(Client, Input, Options)
import_hypervisor_configuration(Client, Input)
Connect to a hypervisor by importing its configuration.
import_hypervisor_configuration(Client, Input, Options)
list_gateways(Client, Input)

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

list_gateways(Client, Input, Options)
list_hypervisors(Client, Input)
Lists your hypervisors.
list_hypervisors(Client, Input, Options)
list_tags_for_resource(Client, Input)
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
list_tags_for_resource(Client, Input, Options)
list_virtual_machines(Client, Input)
Lists your virtual machines.
list_virtual_machines(Client, Input, Options)
put_maintenance_start_time(Client, Input)
Set the maintenance start time for a gateway.
put_maintenance_start_time(Client, Input, Options)
tag_resource(Client, Input)
Tag the resource.
tag_resource(Client, Input, Options)
test_hypervisor_configuration(Client, Input)
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
test_hypervisor_configuration(Client, Input, Options)
untag_resource(Client, Input)
Removes tags from the resource.
untag_resource(Client, Input, Options)
update_gateway_information(Client, Input)

Updates a gateway's name.

update_gateway_information(Client, Input, Options)
update_hypervisor(Client, Input)

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

update_hypervisor(Client, Input, Options)

Link to this section Functions

Link to this function

associate_gateway_to_server(Client, Input)

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

associate_gateway_to_server(Client, Input, Options)

View Source
Link to this function

create_gateway(Client, Input)

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

create_gateway(Client, Input, Options)

View Source
Link to this function

delete_gateway(Client, Input)

View Source
Deletes a backup gateway.
Link to this function

delete_gateway(Client, Input, Options)

View Source
Link to this function

delete_hypervisor(Client, Input)

View Source
Deletes a hypervisor.
Link to this function

delete_hypervisor(Client, Input, Options)

View Source
Link to this function

disassociate_gateway_from_server(Client, Input)

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

disassociate_gateway_from_server(Client, Input, Options)

View Source
Link to this function

import_hypervisor_configuration(Client, Input)

View Source
Connect to a hypervisor by importing its configuration.
Link to this function

import_hypervisor_configuration(Client, Input, Options)

View Source
Link to this function

list_gateways(Client, Input)

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_gateways(Client, Input, Options)

View Source
Link to this function

list_hypervisors(Client, Input)

View Source
Lists your hypervisors.
Link to this function

list_hypervisors(Client, Input, Options)

View Source
Link to this function

list_tags_for_resource(Client, Input)

View Source
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
Link to this function

list_tags_for_resource(Client, Input, Options)

View Source
Link to this function

list_virtual_machines(Client, Input)

View Source
Lists your virtual machines.
Link to this function

list_virtual_machines(Client, Input, Options)

View Source
Link to this function

put_maintenance_start_time(Client, Input)

View Source
Set the maintenance start time for a gateway.
Link to this function

put_maintenance_start_time(Client, Input, Options)

View Source
Link to this function

tag_resource(Client, Input)

View Source
Tag the resource.
Link to this function

tag_resource(Client, Input, Options)

View Source
Link to this function

test_hypervisor_configuration(Client, Input)

View Source
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
Link to this function

test_hypervisor_configuration(Client, Input, Options)

View Source
Link to this function

untag_resource(Client, Input)

View Source
Removes tags from the resource.
Link to this function

untag_resource(Client, Input, Options)

View Source
Link to this function

update_gateway_information(Client, Input)

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_information(Client, Input, Options)

View Source
Link to this function

update_hypervisor(Client, Input)

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.
Link to this function

update_hypervisor(Client, Input, Options)

View Source