Changed1
[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
Rename Protection Group Folder
DescriptionRename Site Recovery Manager protection group folder.
Request
URLURL
https://{api_host}//pairings/{pairing_id}/protection-management/inventory/{folder_id}/actions/rename
Path Parameters
Path Parameters
string
pairing_id
Required
The ID of a pairing between this Site Recovery Manager server and remote one.
string
folder_id
Required
ID of the protection group folder.
Request Body
Request Body
RenameObjectSpec
of mimetype application/json
Required
Spec describing the new name of the protection group folder.
{
"name": "string"
}
string
name
Required
The new name of the object. The name must be unique amongst peer children nodes.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted
Returns
TaskDrResponseEntity
of type application/json
Task to monitor the operation progress.
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
]
},
"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"
}
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
PowerCLI Client SDK Example
$RenameObjectSpec = Initialize-SrmRenameObjectSpec -Name "MyName"
Invoke-SrmRenameProtectionGroupFolder -pairingId "MypairingId" -folderId "MyfolderId" -renameObjectSpec $renameObjectSpec
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"name":"string"}' https://{api_host}/pairings/{pairing_id}/protection-management/inventory/{folder_id}/actions/rename
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
permissions:
- System.Read
- VcDr.RecoveryProfile.com.vmware.vcDr.Create
- VcDr.ProtectionProfile.com.vmware.vcDr.Edit
x-dr-remote-site-connectivity-contract:
not-authenticated: DEPENDS_ON_PROVIDED_PARAMS
server-down: DEPENDS_ON_PROVIDED_PARAMS
[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
What's changed in latest?
INTRODUCED
On This Page
Protection Operations
post
post
post
post
Create Protection Group Folder
Introduced
delete
delete
Delete Protection Group Folder
Introduced
get
get
get
get
get
get
Get Protection Group Folder
Introduced
get
Get Protection Group Folder Children
Introduced
get
Get Protection Group Folders
Introduced
post
Move Protection Group Folder
Introduced
post
delete
post
post
Rename Protection Group Folder
Introduced
