[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api

Restore All Placeholders

Description

Repair placeholder VMs. Called when the placeholder needs to be recreated due to one of these reasons:

  • Placeholder creation failed.
  • Placeholder was deleted.
  • Placeholder inventory was lost or needs to be reentered - one use case for this is when production VM was a template but then gets converted to a VM. This method can be called only on the recovery site. It does not need primary site to be up for successful completion.

  • Request

    Request

    URL

    URL


    post
    https://{api_host}//pairings/{pairing_id}/protection-management/groups/{group_id}/actions/restore-all-placeholders
    Copy

    Path Parameters

    Path Parameters

    string
    pairing_id Required

    The ID of a pairing between this Site Recovery Manager server and remote one


    string
    group_id Required

    The ID of a protection group defined within current pairing


    Authentication

    Authentication

    This operation uses the following authentication methods.

    Response

    Response

    Response Body

    Response Body

    202 Accepted

    Returns RecreateAllPlaceholderVmsResponseDrResponseEntity of type application/json

    Response containing tasks to monitor the operation progress of different VMs

    {
    	"_meta": {
    		"errors": [
    			{
    				"code": "string",
    				"field": "string",
    				"message": "string"
    			}
    		]
    	},
    	"errors": [
    		"string"
    	],
    	"tasks": [
    		{
    			"complete_time": 0,
    			"description": "string",
    			"description_id": "string",
    			"entity": "string",
    			"entity_name": "string",
    			"error": {
    				"details": "string",
    				"message": "string"
    			},
    			"id": "string",
    			"progress": 0,
    			"queued_time": 0,
    			"result": {},
    			"start_time": 0,
    			"status": "QUEUED"
    		}
    	]
    }
    
    _meta Optional

    Response meta data. Contains data about the response payload data.

    Errors

    Errors

    ResponseError
    400

    Bad request - the server could not understand the request due to invalid syntax or invalid request body content


    401

    Unauthorized - the client must authenticate itself to get the requested response


    ResponseError
    403

    Forbidden - not sufficient access rights to fulfill the request


    404

    Not Found - server cannot find the requested in URL resource


    ResponseError
    500

    Internal server error - unexpected condition prevents fulfilling the request

    Code Samples

    Code Samples

    PowerCLI Client SDK Example

    Invoke-SrmRestoreAllPlaceholders -pairingId "MypairingId" -groupId "MygroupId"

    cURL Command

    curl -X POST https://{api_host}/pairings/{pairing_id}/protection-management/groups/{group_id}/actions/restore-all-placeholders
    Vendor Extensions

    Vendor Extensions

    This operation contains the following vendor extensions defined in the spec:
    x-dr-permissions:
        permissions:
            - System.View
            - System.Read
            - Resource.com.vmware.vcDr.RecoveryUse
    x-dr-remote-site-connectivity-contract:
        not-authenticated: ERROR
        server-down: ERROR
    


    Feedback

    Was this page helpful?