MarkLogic 9 Product Documentation

xdmp.foreignClusterStatus

xdmp.foreignClusterStatus(
   host-id as (Number|String),
   foreign-cluster-id as (Number|String)
) as ObjectNode

Summary

Returns the status of a foreign cluster from a host's point of view as a JSON node.

Required Privileges

Usage Notes

The structure of the data returned is as follows:

foreignClusterId

The foreign cluster ID.

foreignClusterName

The foreign cluster name.

hostId

The unique key of the host

interesting

Is this interesting.

bootstrapped

Is this bootstrapped.

lastSuccessfulBootstrap

The time of the last bootstrap.

foreignHosts

Information about foreign hosts.

This is an object with the following properties:

foreignHost

This is an object with the following properties:

foreignHostId

The ID of the foreign host.

foreignHostName

The name of the foreign host.

foreignConnectPort

The connect port for the foreign host.

online

Is this online.

secure

Is SSL enabled.

lastOnline

The time it was last online.

lastOffline

The time it was last offline.

foreignDatabases

Information about foreign databases.

This is an object with the following properties:

foreignDatabase

Information about a particular foreign database.

This is an object with the following properties:

foreignDatabaseId

The ID of the foreign database.

foreignDatabaseName

The name of the foreign database.

enabled

Is this enabled.

foreignForestIds

This is an object with the following properties:

foreignForestId

The ID of the foreign forest.

foreignForests

Information about foreign forests.

This is an object with the following properties:

foreignForest

Information about a particular foreign forest.

This is an object with the following properties:

foreignForestId

The ID of the foreign forest.

foreignForestName

The name of the foreign forest.

foreignHostId

The ID of the foreign host.

Example

xdmp.foreignClusterStatus(fn.head(xdmp.bootstrapHosts()),xdmp.cluster("SanFrancisco"));
=>

{
 "foreignClusterId": "5850052649270525451", 
 "foreignClusterName": "SanFrancisco",
 ...
}