Pbm Replication Manager Pbm Query Replication Groups

Pbm Replication Manager Pbm Query Replication Groups

Returns identifiers for replication groups associated with virtual machines, virtual disks or virtual machines and all their disks.

If the query is performed for a virtual machine and all it's disks virtualMachineAndDisks, an entry per disk and one for the virtual machine config will be returned.

Required privileges: StorageProfile.View

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/pbm/PbmReplicationManager/{moId}/PbmQueryReplicationGroups
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case PbmReplicationManager/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Request Body
PbmQueryReplicationGroupsRequestType of type(s) application/json
Required 
{
    "entities": [
        {
            "_typeName": "string",
            "objectType": "string",
            "key": "string",
            "serverUuid": "string"
        }
    ]
}
array of PbmServerObjectRef
entities
Optional

Array of server object references. Valid types are virtualMachine, virtualMachineAndDisks, virtualDiskId, virtualDiskUUID

Authentication
This operation uses the following authentication methods.
Responses
200

Array of query result objects. Each PbmQueryReplicationGroupResult object identifies a virtual machine, or virtual disk and contains the replication group id associated with that entity, if any. It also describes the fault, if there is an error associated with one of the entities.

Returns Array of PbmQueryReplicationGroupResult of type(s) application/json 
[
    {
        "_typeName": "string",
        "object": {
            "_typeName": "string",
            "objectType": "string",
            "key": "string",
            "serverUuid": "string"
        },
        "replicationGroupId": {
            "_typeName": "string",
            "faultDomainId": {
                "_typeName": "string",
                "id": "string"
            },
            "deviceGroupId": {
                "_typeName": "string",
                "id": "string"
            }
        },
        "fault": {
            "_typeName": "string",
            "faultCause": "MethodFault Object",
            "faultMessage": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        }
    }
]

500

InvalidArgument: if entities is null or empty.

PbmFault: If there is an internal service error.

Returns PbmFault of type(s) application/json
This response body class contains all of the following: MethodFault 
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page
Storage Policy Operations
POST
Pbm Replication Manager Pbm Query Replication Groups