VMware Site Recovery Manager REST API Gateway Operations Index

VMware Site Recovery Manager REST API Gateway Operations Index

All available VMware Site Recovery Manager REST API Gateway Operations

Authentication

Get Current Session

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.

Inventory Mappings

Create Folder Mapping

Add folder mappings for an SRM in a given pairing.

Create Network Mapping

Add network mappings for an SRM in a given pairing.

Create Placeholder Datastores

Add placeholder datastores for an SRM in a given pairing.

Create Resource Mapping

Add resource mappings for an SRM in a given pairing.

Create Storage Policy Mapping

Add storage policy mappings for an SRM in a given pairing.

Create Test Network Mappings

Add test network mappings for an SRM in a given pairing.

Delete Folder Mapping

Delete a configured folder mapping for an SRM in a given pairing.

Delete Network Mapping

Delete a configured network mapping for an SRM in a given pairing.

Delete Placeholder Datastore

Delete a configured placeholder datastore for an SRM in a given pairing.

Delete Resource Mapping

Delete a configured resource mapping for an SRM in a given pairing.

Delete Storage Policy Mapping

Delete a configured storage policy mapping for an SRM in a given pairing.

Delete Test Network Mapping

Delete a configured test network mapping for an SRM in a given pairing.

Get Folder Mapping

Get details about a configured folder mapping for an SRM in a given pairing.

Get Folder Mappings

Get currently configured folder mappings for an SRM in a given pairing.

Get Network Ip Subnet Mapping

Get details about a configured IP subnet mapping for a network mapping.

Get Network Mapping

Get details about a configured network mapping for an SRM in a given pairing.

Get Network Mappings

Get currently configured network mappings for an SRM in a given pairing.

Get Placeholder Datastore

Get details about a configured placeholder datastore for an SRM in a given pairing.

Get Placeholder Datastores

Get currently configured placeholder datastores for an SRM in a given pairing.

Get Resource Mapping

Get details about a configured resource mapping for an SRM in a given pairing.

Get Resource Mappings

Get currently configured resource mappings for an SRM in a given pairing.

Get Storage Policy Mapping

Get details about a configured storage policy mapping for an SRM in a given pairing.

Get Storage Policy Mappings

Get currently configured storage policy mappings for an SRM in a given pairing.

Get Test Network Mapping

Get details about a configured test network mappings for an SRM in a given pairing.

Get Test Network Mappings

Get currently configured test network mappings for an SRM in a given pairing.

Query Suitable Datastores

A query for suitable datastores to be used as placeholder datastores.

Remove Network Ip Subnet Mapping

Delete the configured IP subnet mapping for a network mapping.

Update Network Ip Subnet Mapping

Create or update the IP subnet mapping for a network mapping.

Pairing

Pair to remote Site Recovery Manager server.

Create Remote Session

Creates a session to the remote Site Recovery Manager server.

Delete existing pairing with remote Site Recovery Manager server.

Get information about the pairing.

Get Pairing Issues

Get all issues for the pairing.

Get a list of all existing pairings.

Get Remote Session

Returns information about the current session to the remote Site Recovery Manager server, if any.

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 a list of all Site Recovery Manager servers in the pairing.

Reconnect Pairing

Reconnect existing pairing to remote Site Recovery Manager server.

Protection

Add Datastore Group

Add a replicated datastore group to a protection group in a given pairing.

Configure protection for all virtual machines that are part of the protection group in a given pairing.

Create a new protection group in a given pairing.

Create Protection Group Folder

Create Site Recovery Manager protection group folder.

Delete a protection group in a given pairing.

Delete Protection Group Folder

Remove Site Recovery Manager protection group folder.

Get information about all protection groups in a given pairing.

Get Datastore Group

Get details about a replicated datastore group of a protection group in a given pairing.

Get Datastore Groups

Get a list of replicated datastore groups for a protection group in a given pairing.

Get information about a protection group in a given pairing.

Get Group Issues

Get issues about a protection group in a given pairing.

Get Group Related Recovery Plans

Get recovery plans in which the protection group is part of.

Get details about a protected virtual machine that is part of a protection group in a given pairing.

Get a list of virtual machines that are part of a protection group in a given pairing.

Get Protection Group Folder

Get information about Site Recovery Manager protection group folder.

Get Protection Group Folder Children

Get information about Site Recovery Manager protection group folder children.

Get Protection Group Folders

Get information about Site Recovery Manager server protection inventory.

Get Vm Protection Settings

Get details about the current protection settings of a virtual machine.

Get Vvol Replication Group

Get information about the source vSphere Virtual Volumes (vVols) replication group for a protection group in a given pairing.

Get Vvol Replication Groups

Get the source VVOL replication groups for a protection group in a given pairing.

Move Protection Group Folder

Move Site Recovery Manager protection group folder.

Reconfigure Group

Reconfigure settings for a protection group in a given pairing.

Remove Datastore Group

Remove a replicated datastore group from a protection group in a given pairing.

Remove Vm From Protection Group

Remove a virtual machine from a VR protection group in a given pairing.

Remove Vm Protection

Remove the protection of a virtual machine within a protection group in a given pairing.

Rename Protection Group Folder

Rename Site Recovery Manager protection group folder.

Restore All Placeholders

Repair all placeholder virtual machines that are part of the protection group in a given pairing.

Update Vm Protection Settings

Update the protection settings of a virtual machine.

Recovery

Cancel Recovery Plan

Cancels a running recovery task.

Create a new recovery plan in a given pairing.

Create Recovery Plan Folder

Create Site Recovery Manager recovery plan folder.

Create Recovery Steps Callout

Add a callout/prompt to the list of recovery steps in a given recovery view mode.

Delete Recovery Plan

Delete a recovery plan from a given pairing.

Delete Recovery Plan Folder

Delete Site Recovery Manager recovery plan folder.

Delete Recovery Step

Delete a recovery step in a given recovery view mode.

Dismiss Recovery Steps Recovery Plan Prompt

Dismiss a given user prompt waiting for a client acknowledgment during a recovery operation.

Edit Recovery Steps Callout

Modify a callout/prompt to the list of recovery steps in a given recovery view mode.

Get All Plan History Records

Get a list of all history reports for recovery runs in a given timeframe in a given pairing.

Get All Recovery Plans

Get a list of all recovery plans in a given pairing.

Get Plan History Record

Get information about the history report for a recovery run of a recovery plan in a given pairing.

Get Plan History Records

Get a list of all history reports for recovery runs in a given timeframe of a recovery plan in a given pairing.

Get Plan Related Protection Groups

Get protection groups that are part of a recovery plan in a given pairing.

Get Plan Related Test Networks

Get the test networks configured for a recovery plan in a given pairing.

Get Plan Virtual Machine

Get the protected virtual machine included in a recovery plan in a given pairing.

Get Plan Virtual Machine Dependent Vms

Get the dependent VMs for a protected virtual machine.

Get Plan Virtual Machine Ip Customization

Get the IP customization for a protected virtual machine.

Get Plan Virtual Machine Recovery Priority

Get the protected virtual machine priority during a recovery.

Get Plan Virtual Machine Recovery Settings

Get recovery settings for a protected virtual machine.

Get Plan Virtual Machines

Get virtual machines that are part of a recovery plan in a given pairing.

Get Plan Virtual Machine Summarized Recovery Settings

Get a summary of the recovery settings for a protected virtual machine.

Get Recovery Plan

Get information about a recovery plan in a given pairing.

Get Recovery Plan Folder

Get information about Site Recovery Manager recovery plan folder.

Get Recovery Plan Folder Children

Get information about Site Recovery Manager recovery plan folder children.

Get Recovery Plan Folders

Get information about Site Recovery Manager server recovery inventory.

Get Recovery Plan Issues

Get issues about a recovery plan in a given pairing.

Get Recovery Step

Get information about a recovery step in a given recovery view mode.

Get Recovery Steps

Get information about recovery steps in a given recovery view mode

Get Recovery Steps Callout Details

Get data about a callout/prompt related to a given recovery step in a given recovery view mode.

Get Recovery Steps User Prompt

Get information about a given user prompt currently waiting for an acknowledgment.

Get Recovery Steps User Prompts

Get a list of all user prompts currently waiting for an acknowledgment.

Move Recovery Plan Folder

Move Site Recovery Manager recovery plan folder.

Plan Virtual Machine Check Dependent Vms

Checks if a given list of dependent VMs is valid against the current VM.

Reconfigure Recovery Plan

Reconfigure settings for a recovery in a given pairing.

Rename Recovery Plan Folder

Rename Site Recovery Manager recovery plan folder.

Run Cleanup Test Recovery

Run a cleanup after a test recovery for a recovery plan in a given pairing.

Run the recovery for a recovery plan in a given pairing.

Run the reprotect operation after a successful recovery for a recovery plan in a given pairing.

Run Test Recovery

Run a test recovery for a recovery plan in a given pairing.

Update Plan Virtual Machine Dependent Vms

Update the dependent VMs of a protected virtual machine.

Update Plan Virtual Machine Ip Customization

Update the IP customization for a protected virtual machine.

Update Plan Virtual Machine Recovery Priority

Update the recovery priority of a protected virtual machine.

Update Plan Virtual Machine Recovery Settings

Update recovery settings for a protected virtual machine.

Replication

Create Array Manager

Create a Site Recovery Manager array manager.

Create Replicated Array Pair

Create a Site Recovery Manager replicated array pair.

Delete Array Manager

Delete a Site Recovery Manager array manager.

Delete Replicated Array Pair

Delete a Site Recovery Manager replicated array pair.

Discover Replicated Array Pairs

Discovers storage arrays configured for replication by executing SRA command discoverArrays.

Discover Storage Devices

Discover storage devices and consistency groups of a Site Recovery Manager replicated array pair.

Get All Vvol Fault Domain Replication Groups

Get information about all replication groups that are part of a VMware vSphere Virtual Volumes fault domain.

Get All Vvol Fault Domains

Get information about all VMware vSphere Virtual Volumes (vVols) fault domains that are part of a given pairing.

Get Array Manager

Get information about a Site Recovery Manager array manager.

Get Array Managers

Get information about all Site Recovery Manager array managers.

Get Replicated Array Pair

Get information about a Site Recovery Manager replicated array pair.

Get Replicated Array Pairs

Get information about all Site Recovery Manager replicated array pairs.

Get Storage Adapter

Get information about a storage replication adapter of a Site Recovery Manager.

Get Storage Adapter Connection Params

Get connection parameters for a storage replication adapter of a Site Recovery Manager.

Get Storage Adapters

Get information about all storage replication adapters of a Site Recovery Manager.

Get Storage Devices

Get information about all storage devices of a Site Recovery Manager replicated array pair.

Get Vvol Fault Domain

Get details about a VMware vSphere Virtual Volumes (vVols) fault domain that is part of a given pairing.

Get Vvol Fault Domain Replication Group

Get information about a replication group that is part of a VMware Virtual Volumes fault domain.

Retrieve Unassigned Datastore Groups

Retrieve the unassigned datastore groups that are part of a replicated array pair. You can include these datastore groups in the Array-Based Replication protection groups.

Server

Information about the current Site Recovery Manager server.

Tasks

Get Recent Tasks Info

Retrieve all the recent tasks.

Retrieve the task information.

Vcenters

Browse Vcenter Compute Item

Browse files and folders accessible to vCenter server's compute object.

Get Replicated Vms

Get a list of VMs replicated by vSphere Replication in a given vCenter Server.

Get information about a vCenter Server that is part of a given pairing.

Get Vcenter Compute Inventory

Get information about the vCenter Server's compute inventory.

Get Vcenter Compute Item

Get information about the vCenter Server's compute object.

Get Vcenter Datastore Item

Get information about the vCenter Server's datastore object.

Get Vcenter Datastores

Get information about the vCenter Server's datastores.

Get Vcenter Network Inventory

Get information about the vCenter Server's network inventory.

Get Vcenter Network Item

Get information about the vCenter Server's network object.

Get a list of all vCenter Server instances in the pairing.

Get Vcenter Vm Folder

Get information about the vCenter Server's VM folder object.

Get Vcenter Vm Folder Inventory

Get information about the vCenter Server's VM folder inventory.

Get Vc Storage Policies

Retrieve the vCenter Server's storage policies.

Get Vc Storage Policy

Get information about the vCenter Server's storage policy object.