vcenter topology replication status: list
Returns the replication information of vCenter and Platform Services Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see vcenter.topology.nodes.info.type) matching the vcenter.topology.replication_status.filter_spec. This operation was added in vSphere API 6.7.2.
Request:
HTTP request
GET https://{server}/rest/vcenter/topology/replication-status
?filter.nodes.1=obj-103
&filter.nodes.2=obj-103
?filter.nodes.1=obj-103
&filter.nodes.2=obj-103
Request Query Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| filter | filter_spec | Optional. Specification of matching vCenter and Platform Services Controller nodes for which information should be returned. |
| filter.nodes | string[] | Identifier that a vCenter and Platform Services Controller node must have to match the filter. (see vcenter.topology.replication_status.summary.node). This attribute was added in vSphere API 6.7.2. Optional. If unset or empty, all vCenter and Platform Services Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL match the filter.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.VCenter.name. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.VCenter.name. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : [
{
"node" : "obj-103",
"change_lag" : 1,
"status_available" : true,
"partner_available" : true,
"replicating" : true,
"replication_partner" : "obj-103"
},
{
"node" : "obj-103",
"change_lag" : 1,
"status_available" : true,
"partner_available" : true,
"replicating" : true,
"replication_partner" : "obj-103"
}
]
}
"value" : [
{
"node" : "obj-103",
"change_lag" : 1,
"status_available" : true,
"partner_available" : true,
"replicating" : true,
"replication_partner" : "obj-103"
},
{
"node" : "obj-103",
"change_lag" : 1,
"status_available" : true,
"partner_available" : true,
"replicating" : true,
"replication_partner" : "obj-103"
}
]
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | summary[] | Commonly used replication information about vCenter and Platform Services Controller nodes matching the vcenter.topology.replication_status.filter_spec. |
| value[].node | string | Identifier for the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node. This attribute was added in vSphere API 6.7.2. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.VCenter.name. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.VCenter.name. |
| value[].replication_partner | string | Identifier for the vCenter or Platform Services Controller replication partner. Identifier can be either IP address or DNS resolvable name of the replication partner. This attribute was added in vSphere API 6.7.2. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.VCenter.name. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.VCenter.name. |
| value[].partner_available | boolean | Indicates if the VMware Directory Service on partner is reachable or not. This attribute was added in vSphere API 6.7.2. |
| value[].status_available | boolean | Indicates if the replication status for the node with respect to replication partner can be retrieved or not. This attribute was added in vSphere API 6.7.2. |
| value[].replicating | boolean | Indicates if node is processing replication changes from the replication partner. This attribute was added in vSphere API 6.7.2. Optional. This field will be unset if the partner host or replication status is not available, i.e, if vcenter.topology.replication_status.summary.partner_available or vcenter.topology.replication_status.summary.status_available is false. |
| value[].change_lag | long | Number of replication changes node is behind the replication partner. This attribute was added in vSphere API 6.7.2. Optional. This field will be unset if the partner host or replication status is not available, i.e, if vcenter.topology.replication_status.summary.partner_available or vcenter.topology.replication_status.summary.status_available is false. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 401 | unauthenticated | if the user can not be authenticated. |
| 403 | unauthorized | if the user doesn't have the required privileges. |
| 400 | invalid_argument | if the vcenter.topology.replication_status.filter_spec.nodes field contains a invalid value. |