link data type properties

The table below describes the properties included in the link data type.

Property name

Data type

Description

Notes

compression

Boolean

Specifies whether HCP should compress data before transmitting it to the other system involved in the replication link. For an active/active link, this setting applies to data being replicated in both directions on the link.

Valid values are:

true — HCP should compress data.

false — HCP should not compress data.

The default is false.

This property is optional on a PUT request.

connection

connection

Identifies the remote system for the replication link and specifies how the two systems should communicate with each other.

For details, see connection.

This property is required on a PUT request.

description

String

Specifies a description of the replication link. This description is optional. The default is no description.

To remove a description from an existing link, specify the description property with no value.

For the rules for descriptions, see Common property values.

This property is optional on a PUT request.

encryption

Boolean

Specifies whether HCP should encrypt data before transmitting it to the other system involved in the replication link. For an active/active link, this setting applies to data being replicated in both directions on the link.

Valid values are:

true — HCP should encrypt data.

false — HCP should not encrypt data.

The default is false.

This property is optional on a PUT request.

failoverSettings

failover
Settings

Specifies the automatic failover and failback settings for the replication link.

For details, see failoverSettings.

This property is optional on a PUT request.

id

String

Specifies the system-supplied unique ID for the replication link. HCP generates this ID automatically when you create a link.

This property is not valid on a PUT or POST request. It is returned only by a verbose GET request.

name

String

Specifies the name of the replication link. Link names must be from one through 64 characters long and can contain any valid UTF-8 characters, including white space. Link names are not case sensitive.

Link names must be unique within a replication topology.

This property is required on a PUT request.

priority

String

Specifies whether priority should be given to objects with the oldest changes, regardless of namespace, or processing should be balanced across namespaces. For an active/active link, this setting applies to both systems involved in the link.

Valid values are:

FAIR — Balance processing across namespaces.

OLDEST_FIRST — Give priority to objects with the oldest changes.

The default is OLDEST_FIRST.

These values are not case sensitive.

This property is optional on a PUT request.

statistics

statistics

Specifies information about activity on the replication link.

For details, see statistics (data type for replication link statistics property).

This property is not valid on a PUT or POST request. It is returned only by a verbose GET request.

status

String

Specifies the general state of the replication link. Possible values are:

GOOD — The link is healthy.

WARNING — The link is healthy, but normal replication is not occurring on the link.

BAD — The link is unhealthy.

This property is not valid on a PUT or POST request. It is returned only by a verbose GET request.

statusMessage

String

Specifies text describing the current state of the replication link. Possible values are:

Synchronizing data

Sending data

Receiving data

Recovering data

Completing recovery

Scheduled off period

Suspended by user

Pending remote reply

Pending

Failed over

Remote storage full, link suspended

Local storage full, link suspended

High error rate

Stalled link

Broken link

For details on these status messages, see Replicating Tenants and Namespaces.

This property is not valid on a PUT or POST request. It is returned only by a verbose GET request.

suspended

Boolean

Specifies whether the replication link is currently suspended. Possible values are:

true — The link is suspended.

false — The link is not suspended.

This property is not valid on a PUT or POST request. It is returned only by a verbose GET request.

type

String

Specifies the replication link type. Valid values are:

ACTIVE_ACTIVE — The link is an active/active link.

OUTBOUND — The link is an outbound active/passive link.

INBOUND — The link is an inbound active/passive link.

These values are not case sensitive.

This property is required on a PUT request.

You can change the value of this property from OUTBOUND or INBOUND to ACTIVE_ACTIVE. You cannot change the value from:

ACTIVE_ACTIVE to OUTBOUND or INBOUND

OUTBOUND to INBOUND

INBOUND to OUTBOUND

Trademarks and Legal Disclaimer

© 2016 Hitachi Data Systems Corporation. All rights reserved.