This API has a deprecated equivalent from v7.0U1.
List Replication Status
Returns the replication information of vCenter and Platform Services Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see Nodes.Info.type) matching the ReplicationStatus.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
Request
URLURL
https://{api_host}/api/vcenter/topology/replication-status
Query Parameters
Query Parameters
array of
string
nodes
Optional
Identifier that a vCenter and Platform Services Controller node must have to match the filter. (see ReplicationStatus.Summary.node). 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.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
TopologyReplicationStatusSummary
of type application/json
Commonly used replication information about vCenter and Platform Services Controller nodes matching the ReplicationStatus.FilterSpec.
[
{
"change_lag": 0,
"node": "string",
"partner_available": false,
"replicating": false,
"replication_partner": "string",
"status_available": false
}
]
string
node
Required
Identifier for the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node. 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.
boolean
partner_available
Required
Indicates if the VMware Directory Service on partner is reachable or not.
string
replication_partner
Required
Identifier for the vCenter or Platform Services Controller replication partner. Identifier can be either IP address or DNS resolvable name of the replication partner. 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.
boolean
status_available
Required
Indicates if the replication status for the node with respect to replication partner can be retrieved or not.
integer
change_lag
Optional
Number of replication changes node is behind the replication partner. This field will be unset if the partner host or replication status is not available, i.e, if ReplicationStatus.Summary.partner-available or ReplicationStatus.Summary.status-available is false.
boolean
replicating
Optional
Indicates if node is processing replication changes from the replication partner. This field will be unset if the partner host or replication status is not available, i.e, if ReplicationStatus.Summary.partner-available or ReplicationStatus.Summary.status-available is false.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the ReplicationStatus.FilterSpec.nodes field contains a invalid value.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-ListTopologyReplicationStatus -Nodes "MyNodes"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/topology/replication-status
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/topology/replication-status
x-vmw-doc-operation: list
Availability
Added in 7.0U2
