VMware Site Recovery Manager REST API Gateway Operations Index
All available VMware Site Recovery Manager REST API Gateway Operations
Returns information about the current session, if any.
Logs in and returns the session ID. In the subsequent requests, include the 'x-dr-session' header with the value of the returned session ID.
Logs out if the session is authenticated.
Get currently configured folder mappings for an SRM in a given pairing.
Add folder mappings for an SRM in a given pairing.
Get details about a configured folder mapping for an SRM in a given pairing.
Delete a configured folder mapping for an SRM in a given pairing.
Get currently configured network mappings for an SRM in a given pairing.
Add network mappings for an SRM in a given pairing.
Get details about a configured network mapping for an SRM in a given pairing.
Delete a configured network mapping for an SRM in a given pairing.
Get details about a configured IP subnet mapping for a network mapping.
Create or update the IP subnet mapping for a network mapping.
Delete the configured IP subnet mapping for a network mapping.
Get currently configured placeholder datastores for an SRM in a given pairing.
Add placeholder datastores for an SRM in a given pairing.
A query for suitable datastores to be used as placeholder datastores.
Get details about a configured placeholder datastore for an SRM in a given pairing.
Delete a configured placeholder datastore for an SRM in a given pairing.
Get currently configured resource mappings for an SRM in a given pairing.
Add resource mappings for an SRM in a given pairing.
Get details about a configured resource mapping for an SRM in a given pairing.
Delete a configured resource mapping for an SRM in a given pairing.
Get currently configured storage policy mappings for an SRM in a given pairing.
Add storage policy mappings for an SRM in a given pairing.
Get details about a configured storage policy mapping for an SRM in a given pairing.
Delete a configured storage policy mapping for an SRM in a given pairing.
Get currently configured test network mappings for an SRM in a given pairing.
Add test network mappings for an SRM in a given pairing.
Get details about a configured test network mappings for an SRM in a given pairing.
Delete a configured test network mapping for an SRM in a given pairing.
Get a list of all existing pairings.
Get information about the pairing.
Get all issues for the pairing.
Returns information about the current session to the remote Site Recovery Manager server, if any.
Creates a session to the remote Site Recovery Manager server.
Get a list of all Site Recovery Manager servers in the pairing.
Get information about a Site Recovery Manager server, which is part of a given pairing.
Get a list of all Site Recovery Manager server issues for a given Site Recovery Manager server.
Get information about all protection groups in a given pairing.
Create a new protection group in a given pairing.
Get information about a protection group in a given pairing.
Delete a protection group in a given pairing.
Configure protection for all virtual machines that are part of the protection group in a given pairing.
Reconfigure settings for this group
Repair placeholder VMs. Called when the placeholder needs to be recreated due to one of these reasons:
List of replicated datastore groups. Each datastore group represents a minimal set of datastores that must be protected and recovered together. The rules for combining datastores are:
- datastores are backed by storage devices from the same consistency group;
- virtual machine spans multiple datastores;
- two virtual machines on two different datastores share an RDM device.
Add a replicated datastore group from an Array-Based Replication protection group. This operation also protects all VMs, including VMs residing on any datastore that is part of the newly added datastore group. For a non-Array-Based Replication protection group, this will return an empty response.
A group of replicated datastores. A datastore group represents a minimal set of datastores that must be protected and recovered together. The rules for combining datastores are:
- Datastores are backed by storage devices from the same consistency group;
- Virtual machine spans multiple datastores;
- Two virtual machines on two different datastores share an RDM device.
Remove a replicated datastore group from an Array-Based Replication protection group. This operation also removes the protection of VMs residing on any datastore that is part of the removed datastore group.
Get issues about a protection group in a given pairing.
Get recovery plans in which the protection group is part of.
The source VVOL replication groups for this protection group. Both protection and recovery site report the same replication groups. For non-VVOL protection group, this will return an error response
The source vSphere Virtual Volumes replication groups for this protection group. Both protection and recovery site report the same replication groups.
A list of details for virtual machines that are part of the protection group.
Details of a protected virtual machine that is part of the protection group.
Remove the virtual machine for a VR protection group
Remove the protection of a given virtual machine for this group. Once the protection of a VM is removed, the VM will not be recovered during recovery. To protect the VM again, run the configure protection operation.
Get details about the current protection settings of a virtual machine.
Update the protection settings of a virtual machine. This endpoint must be called after the remove protection operation in order for the VM to be recovered during recovery.
If no start_date and end_date are specified, then the last seven days of data will be returned.
Recovery plans are used for automating the recovery execution during a migration or a failover.
Create a new recovery plan in a given pairing.
Recovery plans are used for automating the recovery execution during a migration or a failover.
Delete a recovery plan from a given pairing.
Cancels a running recovery task for this recovery plan.
Run a cleanup test recovery for this recovery plan.
Reconfigure settings for this recovery plan.
Run the recovery for this recovery plan.
Run reprotect for this recovery plan. Complete a recovery, and start protecting the groups so they can be recovered on the peer site. Reprotect involves unregistering the VMs on the peer site, configuring storage, and registering placeholders. The callers must ensure that they have all the required privileges for VM creation, deletion, and reconfiguration.
Run a test recovery for this recovery plan, leaving the primary site unaffected.
If no start_date and end_date are specified, then the last seven days of data will be returned.
Get information about the history report for a recovery run of a recovery plan in a given pairing.
Get issues about a recovery plan in a given pairing.
Get protection groups that are part of a recovery plan in a given pairing.
Get the test networks configured for a recovery plan in a given pairing.
Get virtual machines that are part of a recovery plan in a given pairing.
Get the protected virtual machine included in a recovery plan in a given pairing.
Get recovery settings for a protected virtual machine.
Update recovery settings for a protected virtual machine.
Get the dependent VMs for a protected virtual machine.
Update the dependent VMs of a protected virtual machine.
Checks if a given list of dependent VMs is valid against the current VM.
Get the IP customization for a protected virtual machine.
Update the IP customization for a protected virtual machine.
Get the protected virtual machine priority during a recovery.
Update the recovery priority of a protected virtual machine.
Get a summary of the recovery settings for a protected virtual machine.
Get information about replicated array pairs that are part of a given pairing.
Get information about a replicated array pair that is part of a given pairing.
Retrieve the unassigned datastore groups that are part of a replicated array pair. These datastore groups could be included in the Array-Based Replication protection groups.
Get information about all VMware vSphere Virtual Volumes (vVols) fault domains that are part of a given pairing.
Get details about a VMware vSphere Virtual Volumes (vVols) fault domain that is part of a given pairing.
Get information about all replication groups that are part of a VMware vSphere Virtual Volumes fault domain.
Get information about a replication group that is part of a VMware Virtual Volumes fault domain.
Information about the current Site Recovery Manager server.
Retrieve all the recent tasks.
Retrieve the task information.
Get a list of all vCenter Server instances in the pairing.
Get information about a vCenter Server that is part of a given pairing.
Get information about the vCenter Server's compute inventory.
Get information about the vCenter Server's compute object.
Get information about the vCenter Server's datastores.
Get information about the vCenter Server's datastore object.
Get information about the vCenter Server's network inventory.
Get information about the vCenter Server's network object.
Returns a list of children of a given folder by path.
Get information about the vCenter Server's VM folder object.
Replicated VMs that are not protected by Site Recovery Manager can be used to create a protection group.
Retrieve the vCenter Server's storage policies.
Get information about the vCenter Server's storage policy object.