[{"label":"Latest (1.0.0alpha)","version":"latest"}]

vcdr

Get Protected Virtual Machines

Description

Get a list of all protected VMs currently being replicated to the specified cloud file system. VMs will not be returned if they are not contained within at least one protection group snapshot in the specified cloud file system.

Request

URL

get

https://{orchestrator_fqdn}/api/vcdr/v1alpha/cloud-file-systems/{cloud_file_system_id}/protected-vms

Copy

Path Parameters

string

cloud_file_system_id Required

Unique identifier of an individual cloud file system. Use the cloud file system ID of the cloud file system from where you want to get a list of all protected VMs.

Query Parameters

string

cursor Optional

An opaque string previously returned by this API that can be passed to this API in order to get the next set of results. If this property is not passed, enumeration of starts from the beginning.

VmsFilterSpec

filter_spec Optional

Used to filter the results.

integer

limit Optional

The maximum number of results to return with the call. The maximum is 500, and the default is 50 results.

Authentication

This operation uses the following authentication methods.

api_key

Response

Response Body

200 OK

Returns GetProtectedVirtualMachinesResponse of type application/json

OK. The request succeeded.

{
	"cursor": "string",
	"vms": [
		{
			"id": "string",
			"name": "string",
			"size": 0,
			"vcdr_vm_id": "string"
		}
	]
}

string

cursor Optional

An opaque string that can be passed back to this API in order to get the next set of results. If this poperty is not present, no more results are available.

array of VmSummary

vms Optional

An array of summary information concerning protected VMs

Errors

400

Bad request. The server could not understand the request.

401

Unauthorized. The client has not authenticated.

403

Forbidden. The client is not authorized.

404

Not found. The server cannot find the specified resource.

Error

500

VMware Cloud DR-specific error.
An error unique to VMware Cloud DR was encountered while attempting to satisfy the request. See the returned object for details on the error.

Code Samples

cURL Command

curl https://{orchestrator_fqdn}/api/vcdr/v1alpha/cloud-file-systems/{cloud_file_system_id}/protected-vms

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vcdr-roles-config:
    mutatorMethod: false
    roles:
        - DR_ADMIN
        - DR_TESTER
        - BACKUP_ADMIN
        - SERVICE_ADMIN
        - SDDC_ADMIN
        - AUDITOR

[{"label":"Latest (1.0.0alpha)","version":"latest"}]

vcdr

Protected VM Operations

get

Get Protected Virtual Machines

Get Protected Virtual Machines

Request

URL

Path Parameters

Query Parameters

Authentication

api_key

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

Vendor Extensions

On This Page

Protected VM Operations

Was this page helpful?