connection

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

The connection data type describes the connection property of the link data type.

connection data type properties

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

Property name Data type Description Notes
localHost String

Identifies the local system for the replication link. Valid values are:

  • The domain name for the remote system for the link to use for communication with the local system (as that name is known to the remote system), in either of these formats:
    • replication.hcp-domain-
    • name
    • replication.admin.
    • hcp-domain-name
  • One or more comma-separated IP addresses of storage nodes in the local system (as those addresses are known to the remote system)

For more information about these values, see the description of the remoteHost property.

Typically, you specify this property on a PUT request to create a link only if the system on which you’re creating the link uses network address translation (NAT) for communication with the other system.

 This property is optional on a PUT request to create a replication link.
localPort Integer

Specifies the port on which the local system for the replication link listens for data from the remote system. The default is 5748.

Typically, you specify a different port only if other port usage makes it necessary.

 This property is optional on a PUT request to create a replication link.
remoteHost String

Identifies the remote system for the replication link. Valid values are:

  • The domain name of the remote system, in either of these formats:
    • replication.hcp-domain-
    • name
    • replication.admin.
    • hcp-domain-name

      hcp-domain-name must be the name of the domain associated with the network that’s selected for replication on the remote system. The second format is required if the domain for the replication network is shared with other networks.

  • One or more comma-separated IP addresses of storage nodes in the remote system. These must be the node IP addresses in the network that’s selected for replication on the remote system.

    The local system for the link transmits data only to the nodes identified by the domain name or IP addresses you specify. Therefore, you should specify IP addresses only if you have a compelling reason to do so (for example, HCP is not using DNS, or you need to reduce the processing load on some number of nodes).

 This property is required on a PUT request to create a replication link.
remotePort Integer

Specifies the port on which the remote system for the replication link listens for data from the local system. The default is 5748.

Typically, you specify a different port only if other port usage makes it necessary.

 This property is optional on a PUT request to create a replication link.

Example

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

<connection>
    <localHost>
    192.168.210.16, 192.168.210.17, 192.168.210.18, 192.168.210.19
    </localHost>
    <localPort>5748</localPort>
    <remoteHost>replication.admin.hcp-ca.example.com</remoteHost>
    <remotePort>5748</remotePort>
</connection>