virtual_machines

Creates, updates, deletes, gets or lists a virtual_machines resource.

Overview

Name	virtual_machines
Type	Resource
Id	aws.backup_gateway.virtual_machines

Fields

The following fields are returned by SELECT queries:

get_virtual_machine

Name	Datatype	Description
host_name	string	The host name of the virtual machine. (pattern: <code>[a-zA-Z0-9-]*</code>)
hypervisor_id	string	The ID of the virtual machine's hypervisor.
last_backup_date	string (date-time)	The most recent date a virtual machine was backed up, in Unix format and UTC time.
name	string	The name of the virtual machine. (pattern: <code>[a-zA-Z0-9-]*</code>)
path	string	The path of the virtual machine. (pattern: <code>[^\x00]+</code>)
resource_arn	string	The Amazon Resource Name (ARN) of the virtual machine. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}/[a-zA-Z-0-9]+</code>)
vmware_tags	array	These are the details of the VMware tags associated with the specified virtual machine.

list_virtual_machines

Name	Datatype	Description
host_name	string	The host name of the virtual machine. (pattern: <code>[a-zA-Z0-9-]*</code>)
hypervisor_id	string	The ID of the virtual machine's hypervisor.
last_backup_date	string (date-time)	The most recent date a virtual machine was backed up, in Unix format and UTC time.
name	string	The name of the virtual machine. (pattern: <code>[a-zA-Z0-9-]*</code>)
path	string	The path of the virtual machine. (pattern: <code>[^\x00]+</code>)
resource_arn	string	The Amazon Resource Name (ARN) of the virtual machine. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}/[a-zA-Z-0-9]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_virtual_machine	select	region		By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
list_virtual_machines	select	region		Lists your virtual machines.
start_virtual_machines_metadata_sync	exec	region, HypervisorArn		This action sends a request to sync metadata across the specified virtual machines.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_virtual_machine

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

SELECT
host_name,
hypervisor_id,
last_backup_date,
name,
path,
resource_arn,
vmware_tags
FROM aws.backup_gateway.virtual_machines
WHERE region = '{{ region }}' -- required
;

list_virtual_machines

Lists your virtual machines.

SELECT
host_name,
hypervisor_id,
last_backup_date,
name,
path,
resource_arn
FROM aws.backup_gateway.virtual_machines
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

start_virtual_machines_metadata_sync

This action sends a request to sync metadata across the specified virtual machines.

EXEC aws.backup_gateway.virtual_machines.start_virtual_machines_metadata_sync 
@region='{{ region }}' --required 
@@json=
'{
"HypervisorArn": "{{ HypervisorArn }}"
}'
;