replicationService

Content Platform Tenant Management Help

Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

The replicationService data type describes the replication resource.

replicationService data type properties

The following table describes the properties included in the replicationService data type.

Property name Data type Description Notes

allowTenantsToMonitor

Namespaces

Boolean

Specifies whether the Tenant Management Console for HCP tenants displays the status of replication of the tenant and its namespaces. Valid values are:

true
The Tenant Management Console displays replication status information for all HCP tenants.
false
The Tenant Management Console hide replication status information for all HCP tenants.

The default is false.

connectivityTimeout

Seconds

Integer Specifies how long the HCP system should wait before reporting a replication link connectivity failure. Valid values are integers greater than or equal to zero.
enableDNSFailover Boolean

Specifies whether DNS failover is enabled for the HCP system. Valid values are:

true
DNS failover is enabled for the system.
false
DNS failover is disabled for the system.

The default is false.

enableDomainAnd

Certificate

Synchronization

Boolean

Specifies whether HCP periodically sends its domains and SSL server certificates to each other HCP system with which it participates as a sending system in a replication link. Valid values are:

true
HCP periodically sends its domains and SSL server certificates to each other system with which it participates as a sending system in a replication link.
false
HCP does not send its domains and SSL server certificates to other systems.

The default is false.

This data type has been deprecated and should not be used.
network String

Specifies the replication network for the HCP system. Valid values are any network defined in the HCP system except [hcp_backend]. The default is [hcp_system].

Network names are not case-sensitive.

status String

Specifies whether all activity on all replication links in which the HCP system participates is currently stopped. Possible values are:

ENABLED
Activity on each replication link in which the system participates is occurring according the individual link status.
SHUTDOWN
All activity on all replication links in which the system participates is currently stopped.
This property is not valid on a POST request. It is returned only by a verbose GET request.
verification String

Specifies whether replication verification is enabled for the HCP system. Possible values are:

ON
Replication verification is set to continuously run.
ONCE
Replication verification is set to run only on.
OFF
Replication verification is disabled.

Example

Here’s an XML example of the replicationService data type:

<replicationService>
    <allowTenantsToMonitorNamespaces>false</allowTenantsToMonitorNamespaces>
    <enableDNSFailover>true</enableDNSFailover>
    <network>[hcp_system]</network>
    <connectivityTimeoutSeconds>30</connectivityTimeoutSeconds>
    <status>ENABLED</status>
    <verification>ONCE</verification>
</replicationService>

Query parameters for Replication service actions

To shut down all replication links in which the HCP system participates, you use this query parameter:

shutDownAllLinks=reason

reason is a text string that specifies the reason why you’re shutting down all links. This string can be up to 1,024 characters long and can contain any valid UTF-8 characters, including white space. The string you specify must be percent encoded.

To reestablish all replication links in which the HCP system participates after they have been shut down, you use this query parameter:

reestablishAllLinks

You use the shutDownAllLinks and reestablishAllLinks query parameters with a POST request against the replication resource. You cannot include a request body with this request.

Here’s a sample POST request that shuts down all replication links:

curl -k -iX POST
    -H "Authorization: HCP YWxscm9sZXM=:04EC9F614D89FF5C7126D32ACB448382"
    "https://admin.hcp-ma.example.com:9090/mapi/services/replication
       ?shutDownAllLinks=More%20bandwidth%20for%20app%20XYZ"