Modify a Cross Cluster Connection

Edit the settings for a cross cluster connection.

Use cross cluster connections to perform cross cluster search and cross cluster replication in OCI Search with OpenSearch.

    1. On the Clusters list page, find the cluster that you want to work with. If you need help finding the list page or the cluster, see Listing OpenSearch Clusters.
    2. Find the connection you want to edit in the list, click the actions menu, and then click Edit.

      You can update the name, ping schedule, and whether to skip the cluster if the nodes are unavailable during the search.

      To delete the cross cluster connection instead of editing the settings, select Delete from the actions menu.

    3. Select Save to updating the connection's settings.
  • Use the configureoutboundcluster command and required parameters to edit a cross cluster connection:

    oci opensearch cluster  update --from-json file://<Config_File_Name>.json --profile oc1 --auth security_token  --display-name source

    The following is an example of the json for a cross cluster connection config file:

    {
      "outboundClusterConfig": {
        "isEnabled": true,
        "outboundClusters": [
          {
            "displayName": "remote-cluster",
            "isSkipUnavailable": true,
            "seedClusterId": "ocid1.opensearchcluster.oc1.iad.<inbound_cluster_unique_id>",
            "mode": "SEARCH_AND_REPLICATION"
          }
        ]
      },
    "opensearchClusterId": "ocid1.opensearchcluster.oc1.iad.<outbound_cluster_unique_id>"
    }

    For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

  • For information about using the API and signing requests, see REST APIs and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.

    Run the UpdateOpensearchCluster operation to edit the configuration for a cross cluster connection.