• Glossary
  • Support
  • Downloads
  • DataStax Home
Get Live Help
Expand All
Collapse All

DataStax Enterprise OpsCenter 6.8

    • About OpsCenter
      • New features
      • Key features
      • Labs features
        • Exporting and importing dashboard presets
        • Adding a Swift CLI backup location
        • Configuring named route linking
        • Viewing logs from node details
      • Architecture overview
      • OpsCenter policy for DDAC and OSS
      • Feedback about OpsCenter
    • Release notes
    • Installing OpsCenter
    • Upgrading OpsCenter
    • OpsCenter recommended settings
      • OpsCenter basic configurations
      • Cluster synchronization settings
      • Backup Service settings
      • Knowledge Base articles
    • Configuring OpsCenter
      • OpsCenter Security
        • OpsCenter SSL overview
          • Enabling/Disabling HTTPS for the OpsCenter server
          • Configuring SSL/TLS between OpsCenter and the DataStax Agents
          • Connect to DSE with client-to-node encryption in OpsCenter and the DataStax Agents
          • Editing/OpsCenter cluster connections for authentication or encryption
          • SSL configuration options for OpsCenter
        • Configuring OpsCenter role-based security
        • Encrypting sensitive configuration values
          • Activating configuration encryption
          • Creating a system key to encrypt sensitive configuration values
          • Manually encrypting a configuration value
          • Deactivating configuration encryption
        • Authenticating with LDAP
          • Configuring LDAP
          • Adding a role for an LDAP user
          • Troubleshooting OpsCenter LDAP
        • Kerberos authentication
          • Configuring OpsCenter for Kerberos authentication
          • OpsCenter Kerberos configuration options
          • Troubleshooting Kerberos in OpsCenter
        • Configuring security logging
      • Configuring alerts for events
        • SNMP alerts overview
          • Enabling SNMP alerts
        • Enabling SMTP email alerts
        • Enabling alerts posted to a URL
          • Verifying that events are posting correctly
          • Posting URL alerts to a Slack channel
      • Configuring data collection and expiration
        • Controlling data collection
        • Storing collection data on a separate cluster
      • OpsCenter DSE definitions files updates
        • Updating and configuring definitions files properties
      • Automatic failover overview
        • Enabling automatic failover
        • Failover configuration options reference
      • Backing up critical configuration data
      • Configuring named route linking
      • Configuring the OpsCenter JVM
      • Configuring the DataStax Agent JVM
        • Setting and securing the tmp directory for the DataStax Agent
        • Encrypting JMX communications
      • Changing the replication strategy for the OpsCenter keyspace
      • Configuration files for OpsCenter
        • OpsCenter configuration properties
          • Statistics reporter properties
        • Cluster configuration properties
          • Cassandra connection properties
          • Metrics Collection Properties
        • DataStax Agent configuration
        • OpsCenter logback.xml configuration
      • Customize scripts for starting and stopping DataStax Enterprise
      • Example configuration scenarios
        • Configuring for multiple regions
        • Configuring for very large clusters
    • Using OpsCenter
      • OpsCenter workspace overview
        • Ring View
        • List View
        • DataStax Agents Status View
        • Nodes Detail View
          • Node management operations
      • Configuring alerts
        • Adding an alert for agent issues
          • Troubleshooting DataStax Agent Issues
        • Adding an alert for down nodes
        • Configuring an alert for KMIP errors
        • Configuring an alert for percentage of in-memory usage
        • Configuring an alert for percentiles
      • Monitoring node operations
        • Viewing the Spark Console
        • Monitoring in-memory usage
        • Viewing logs from node details
      • Managing and maintaining nodes
        • Running cleanup
        • Performing garbage collection
        • Running compaction
        • Flushing tables
        • Decommission a node
        • Draining a node
        • Moving a node
        • Running a manual repair
        • Configure an alias for a node
      • Starting and stopping DSE
        • Starting DSE on a node
        • Stopping DSE on a node
        • Restarting DSE on a node
      • Managing keyspaces and tables
        • Keyspaces
          • Managing a keyspace
          • Managing tables
        • Browsing data deprecated
      • Cluster administration
        • Adding an existing cluster
        • Disconnecting a cluster from OpsCenter and Lifecycle Manager
        • Rebalancing a cluster overview
          • Rebalancing a cluster
          • Configuring an alert for rebalancing a cluster
        • Restarting a cluster
        • Changing the display name of a cluster
        • Downloading diagnostic data
          • Diagnostic tarball reference
          • Creating an alternate directory for diagnostic information
        • Downloading Insights diagnostic data
        • Generating a cluster report
      • OpsCenter Metrics Tooltips Reference
        • Dashboard performance metrics
        • Performance metrics overview
          • Working with metrics performance graphs
          • Organizing performance metrics presets
          • Exporting and importing dashboard presets
        • Cluster performance metrics
        • Pending task metrics
          • Pending task metrics for writes
          • Pending task metrics for reads
          • Pending task metrics for cluster operations
        • Table performance metrics
        • Tiered storage performance metrics
          • Configuring tiered storage metric graphs
          • Configuring tiered storage alerts
        • Message latency metrics
          • Adding dashboard graphs for datacenter and node messaging latency
          • Adding alerts for DC and node message latency
        • Search performance metrics
        • Graph metrics
        • NodeSync metrics
        • Thread Pool (TP) metrics
          • Viewing TP stats in Node Details
          • Enabling network backpressure
        • Dropped Messages metrics
        • Operating system performance metrics
        • Alert metrics
          • Advanced system alert metrics
    • OpsCenter 6.8 Reference
      • OpsCenter ports reference
      • Installation and configuration locations
        • Default file locations for package installations
        • Default file locations tarball installations
      • Starting, stopping, and restarting OpsCenter
        • Startup log for OpsCenter
      • Stopping, starting, and restarting DataStax Agents
    • DSE Management Services
      • Backup Service
        • Quick Video Tour: Backup Service
        • Adding a backup location
          • Adding a local file system backup location
          • Adding an Amazon S3 backup location
          • Adding an Azure backup location
        • Backing up data
          • Backing up a cluster
          • Backing up to Amazon S3
          • Backing up and restoring DataStax Graphs in OpsCenter
          • Viewing backup and restore history
          • Synchronizing backup data after an upgrade
          • Deleting backup data
        • Restoring a cluster
          • Restoring from a backup
          • Restoring a backup to a specific point-in-time
          • Monitoring sufficient disk space for restoring backups
        • Cloning cluster data
          • Cloning cluster data from a defined other location
          • Cloning cluster data from clusters managed by the same OpsCenter instance
        • Configuring the Backup Service
          • Configuring commit log backups
          • Configuring the free disk space threshold for backups
          • Configuring encryption key storage for backups
          • Configuring custom scripts to run before and after backups
          • Configuring restore to continue after a download failure
          • Backup Service configuration options
        • Troubleshooting Backup Service errors
      • NodeSync Service
        • Enabling NodeSync
        • Configuring the NodeSync refresh data interval
        • Viewing NodeSync Status
        • Configuring the NodeSync rate using LCM
        • NodeSync metrics
      • Repair Service
        • Repair Service overview
          • Subrange repairs overview
          • Distributed subrange overview
          • Incremental repairs overview
          • Repair Service behavior during environment changes
          • Estimating remaining repair time
        • Turning the Repair Service on
        • Turning the Repair Service off
        • Viewing repair status
        • Basic repair configuration
          • Configuring incremental repairs
          • Excluding keyspaces or tables from subrange repairs
          • Enabling distributed subrange repairs
          • Logging for the Repair Service
          • Basic Repair Service configuration reference
        • Advanced repair configuration
          • Adjusting or disabling the throttle for subrange repairs
          • Running validation compaction sequentially
          • Advanced Repair Service configuration reference
        • Expert repair configuration
          • Setting the maximum for parallel subrange repairs
          • Expert Repair Service configuration reference
          • Tuning Repair Service for multi-datacenter environments
        • Expedited Repair Service configuration
        • Troubleshoot Repair Service errors
        • Learn more about repairs
      • Capacity Service
        • Forecasting trends for metric graphs
        • Advanced forecast configuration
      • Best Practice Service
        • Configuring Best Practice service rules
        • Monitoring the results of Best Practice service scans
        • Best Practice Rules Reference
      • Performance Service
        • Performance Service Overview
        • Why use the OpsCenter Performance Service?
        • Enabling the OpsCenter Performance Service
        • Disabling the OpsCenter Performance Service
        • Setting permissions for the OpsCenter Performance Service
        • Tuning a database cluster with the Performance Service
          • Identifying and tuning slow queries
    • Identifying poorly performing tables
    • Monitoring node thread pool statistics
    • Troubleshooting OpsCenter
    • Lifecycle Manager
      • Overview of Lifecycle Manager
        • Supported capabilities
        • Defining the topology
        • Using configuration profiles
        • Defining repositories
        • Running jobs in LCM
          • Job types in LCM
          • Job concurrency in LCM
        • Monitoring job status
      • Installing DSE using LCM
        • Accessing OpsCenter Lifecycle Manager
        • Creating custom data directories
        • Adding SSH credentials
        • Adding a configuration profile
        • Adding a repository
        • Defining the cluster topology
          • Adding a cluster
          • Adding a datacenter
          • Adding a node
        • Running an installation job
        • Viewing job details
        • Using LCM in an offline environment
          • Required software for offline DSE installs
          • Downloading DSE in an offline environments
      • Managing SSH credentials
        • Adding SSH credentials
        • Editing SSH credentials
        • Deleting SSH credentials
        • Configuring SSH connection thresholds for LCM jobs
      • Managing configuration profiles
        • Adding a configuration profile
        • Editing a configuration profile
        • Customizing configuration profile files
        • Cloning a configuration profile
        • Deleting a configuration profile
        • Configuring an HTTP or HTTPS proxy
      • Configuring repositories
        • Adding a repository
        • Editing a repository
        • Deleting a repository
      • Defining DSE topologies
        • Managing cluster topologies
          • Adding a cluster
          • Editing a cluster
          • Deleting a cluster
          • Importing a cluster topology
        • Managing datacenter topologies
          • Adding a datacenter
          • Editing a datacenter
          • Deleting a datacenter
        • Managing node topologies
          • Adding a node
          • Editing a node
          • Deleting a node
      • Running LCM jobs
        • Running an installation job
        • Running an configure job
        • Running an upgrade job
          • Example: Upgrading DSE to a minor release using LCM
        • Aborting a job
        • Adjusting idle timeout
      • Configuring Java options
        • Choosing a Java vendor in LCM
        • Managing Java installs
        • Configuring JVM options for DSE using LCM
      • Configuring DSE security using LCM
        • Native transport authentication schemes and limitations in LCM
          • Configuring row-level access control
        • Configuring SSL/TLS for DSE
        • Configuring a JMX Connection to DSE
      • Lifecycle Manager configuration options
      • Configuration known issues and limitations
      • Using advanced configurations with LCM
        • Exporting metrics collection
        • Configuring AlwaysOn SQL
        • Configuring DSE Graph
        • Configuring the NodeSync rate
        • Configuring tiered storage
    • OpsCenter API reference for developers
      • Enable and access the Datastax Agent API
      • Authentication
      • OpsCenter configuration
      • Retrieving cluster and node information
      • Performing Cluster Operations
      • Managing Keyspaces and Tables
      • Retrieving Metric Data
      • Managing Events and Alerts
      • Schedule management
      • Backup Management and Restoring from Backups
      • Best Practice Rules
      • Hadoop
      • Spark
      • Managing Performance Service Configuration
      • User Interface
      • Agent Install and Status
      • Cluster Lifecycle Management
      • DataStax Agent API example curl commands
  • DataStax Enterprise OpsCenter 6.8
  • Cluster

Cluster

The cluster model is the parent (owner) of all other objects related to a DSE cluster, whether the cluster physically exists yet or not. In order to be valid for installation and/or configuration, the cluster must have the following:

  • A reference to Repository.

  • A reference to Machine Credentials.

  • A reference to Config Profile.

Managing Clusters URL

Get a cluster object by ID

GET /api/v2/lcm/clusters/{id}

Get a list of clusters

GET /api/v2/lcm/clusters/

Get nodes in a cluster

GET /api/v2/lcm/clusters/{id}/nodes/

Get datacenters in a cluster

GET /api/v2/lcm/clusters/{id}/datacenters/

Get jobs run on a cluster

GET /api/v2/lcm/clusters/{id}/jobs/

Get the cacert for a cluster

GET /api/v2/lcm/clusters/{id}/cacert

Create a cluster

POST /api/v2/lcm/clusters/

Update a cluster

PUT /api/v2/lcm/clusters/{id}

Delete a cluster

DELETE /api/v2/lcm/clusters/{id}

Managing Clusters

Cluster

    {
        "id" : <value>,
        "name" : <value>,
        "comment" : <value>,
        "repository-id" : <value>,
        "machine-credential-id" : <value>,
        "config-profile-id" : <value>,
        "ssh-management-port" : <value>,
        "managed" : <value>,
        "opsc-cluster-id" : <value>,
        "last-job-id" : <value>,
        "job-status" : <value>
    }
Property Description of Values

id

A UUID for the cluster.

name

The name of the cluster. The normal rules for value cluster names apply.

ssh-management-port

SSH port on managed nodes. This defaults to 22 and can be overridden at the Datacenter and/or Node level.

config-profile-id

The ID of the Config Profile to use for this cluster. Can be overridden at the lcm-datacenter and/or Node level.

machine-credential-id

The ID of the Machine Credentials to use for this cluster. Can be overridden at the Datacenter and/or Node level.

repository-id

The ID of the Repository to use for this cluster.

managed

Does LCM manage this cluster and configuration file - should always be set to true. This is used by OpsCenter to support agent installation through LCM without using LCM for DSE installation or configuration.

last-job-id

The ID of the last job run on this cluster. See Jobs.

opsc-cluster-id

A unique ID to link the LCM cluster model with the OpsCenter cluster configuration. This is set automatically at the end of the first successful install job.

comment

A generic field for user comments.

old-password

When internal authentication is enabled, LCM automatically changes the password for the built-in CQL user named cassandra. If LCM can access the cassandra user with the old password, LCM changes the old password to the new password. For new installs of DSE, the old-password must initially be set to: cassandra.

new-password

The desired password for the user named cassandra. See the old-password property above for details.

ldap-username

For DSE clusters using LDAP for CQL authentication, this value is the username for the LDAP account used by OpsCenter for CQL access to the DSE cluster.

GET /api/v2/lcm/clusters/{id}

Gets a specific cluster record by ID.

Path arguments: id: A Cluster ID.

Returns a Cluster object.

Example:

 curl http://localhost:8888/api/v2/lcm/clusters/108f74ab-0c5c-4bf7-8527-695e3e630e1a

Output:

    {
        "id" : "108f74ab-0c5c-4bf7-8527-695e3e630e1a",
        "name" : "test-cluster-01",
        "comment" : null,
        "repository-id" : "7db37bd2-c23a-4ea6-a415-e9faaeb2060f",
        "machine-credential-id" : "0f03dff7-1874-4c17-a823-ff79dba6e694",
        "config-profile-id" : "4ff7a9ae-257c-4a6c-bfb0-b47299f39795",
        "ssh-management-port" : 22
        "managed" : true,
        "opsc-cluster-id" : null,
        "last-job-id" : null,
        "modified-on" : "2016-06-21T14:33:11.859Z",
        "type" : "cluster",
        "job-status" : null,
        "datacenter" : [],
        "created-on" : "2016-06-21T14:33:11.859Z",
        "created-by" : "system",
        "modified-by" : "system",
        "href" : "http://localhost:8888/api/v2/lcm/clusters/108f74ab-0c5c-4bf7-8527-695e3e630e1a",
        "related-resources" : {
           "datacenters" : "http://localhost:8888/api/v2/lcm/clusters/108f74ab-0c5c-4bf7-8527-695e3e630e1a/datacenters/"
        },
    }

GET /api/v2/lcm/clusters/{id}/nodes/

Gets a list of nodes associated with a specific cluster record using the cluster ID.

Path arguments: id: A Cluster ID.

Returns a paginated list of all relevant Node records. See Paginated Results for an overview of the query string parameters that can be used.

Example:

 curl http://localhost:8888/api/v2/lcm/clusters/108f74ab-0c5c-4bf7-8527-695e3e630e1a/nodes/

Output:

    {
        "previous" : null,
        "current" : 1,
        "next" : null,
        "last" : 1,
        "count" : 1,
        "per-page" : 50,
        "results" : [
            {
                "ssh-management-address" : "10.110.110.143",
                "datacenter-id" : "42f611b7-44ef-4fda-8903-b6aa75862ac2",
                "href" : "http://127.0.0.1:8888/api/v2/lcm/nodes/211c7598-70e3-4c50-9c29-bad2aacff127",
                "modified-on" : "2016-10-11T00:08:27.456Z",
                "machine-credential-id" : null,
                "comment" : null,
                "listen-address" : null,
                "native-transport-address" : null,
                "id" : "211c7598-70e3-4c50-9c29-bad2aacff127",
                "rack" : "rack1",
                "created-on" : "2016-07-07T22:18:48.239Z",
                "broadcast-address" : null,
                "last-job-id" : "a6e88a46-bcec-46ab-9fdb-71ba32a14c59",
                "job-status" : "TERMINATED",
                "type" : "node",
                "native-transport-broadcast-address" : null,
                "name" : "501-node",
                "ssh-management-port" : null,
                "config-profile-id" : null,
                "seed" : true,
                "related-resources" : {
                    "datacenter" : "http://127.0.0.1:8888/api/v2/lcm/datacenters/42f611b7-44ef-4fda-8903-b6aa75862ac2"
                }
            }
        ]
    }

GET /api/v2/lcm/clusters/{id}/datacenters/

Gets a list of datacenters associated with a specific cluster record using the cluster ID. This endpoint performs a 302 redirect, which api clients must follow.

Path arguments: id: A Cluster ID.

Returns a paginated list of all relevant Datacenter records. See Paginated Results for an overview of the query string parameters that can be used.

Example:

 curl -L http://localhost:8888/api/v2/lcm/clusters/716c1c44-4cc9-4080-9025-aea0a6bafb9d/datacenters/

Output:

    {
        "last" : 1,
        "per-page" : 50,
        "previous" : null,
        "current" : 1,
        "count" : 1,
        "next" : null,
        "results" : [
            {
                "modified-on" : "2016-07-07T22:26:40.087Z",
                "solr-enabled" : false,
                "job-status" : "TERMINATED",
                "last-job-id" : null,
                "cluster-id" : "716c1c44-4cc9-4080-9025-aea0a6bafb9d",
                "hadoop-enabled" : false,
                "spark-enabled" : false,
                "graph-enabled" : false,
                "comment" : null,
                "created-on" : "2016-07-07T22:16:28.217Z",
                "id" : "42f611b7-44ef-4fda-8903-b6aa75862ac2",
                "type" : "datacenter",
                "name" : "501-dc",
                "machine-credential-id" : null,
                "converged-on" : "2016-07-07T22:26:40.084Z",
                "href" : "http://127.0.0.1:8888/api/v2/lcm/datacenters/42f611b7-44ef-4fda-8903-b6aa75862ac2",
                "ssh-management-port" : null,
                "config-profile-id" : null,
                "related-resources" : {
                    "cluster" : "http://127.0.0.1:8888/api/v2/lcm/clusters/716c1c44-4cc9-4080-9025-aea0a6bafb9d",
                    "nodes" : "http://127.0.0.1:8888/api/v2/lcm/datacenters/42f611b7-44ef-4fda-8903-b6aa75862ac2/nodes/"
                }
           }
       ]
   }

GET /api/v2/lcm/clusters/{id}/jobs/

Gets a list of jobs associated with a specific cluster record using the cluster ID. This endpoint performs a 302 redirect, which api clients must follow.

Path arguments: id: A Cluster ID.

Returns a paginated list of all relevant Job records. See Paginated Results for an overview of the query string parameters that can be used.

Example:

 curl -L http://localhost:8888/api/v2/lcm/clusters/716c1c44-4cc9-4080-9025-aea0a6bafb9d/jobs/

Output:

    {
        "current" : 1,
        "next" : null,
        "results" : [
        {
            "cluster-id" : "716c1c44-4cc9-4080-9025-aea0a6bafb9d",
            "id" : "f0a56ab3-1ec9-4f5a-8f53-cb4c683f2179",
            "modified-on" : "2016-10-07T22:00:19.854Z",
            "created-on" : "2016-07-07T22:19:00.860Z",
            "href" : "http://127.0.0.1:8888/api/v2/lcm/jobs/f0a56ab3-1ec9-4f5a-8f53-cb4c683f2179",
            "job-type" : "install",
            "dry-run" : false,
            "datacenter-name" : null,
            "status" : "FAILED",
            "node-name" : null,
            "datacenter-id" : null,
            "type" : "job",
            "description" : null,
            "node-id" : null,
           "cluster-name" : "501cl-01",
            "related-resources" : {
                "job-nodes" : "http://127.0.0.1:8888/api/v2/lcm/jobs/f0a56ab3-1ec9-4f5a-8f53-cb4c683f2179/job_nodes/",
                "cluster" : "http://127.0.0.1:8888/api/v2/lcm/clusters/716c1c44-4cc9-4080-9025-aea0a6bafb9d",
                "job-events" : "http://127.0.0.1:8888/api/v2/lcm/jobs/f0a56ab3-1ec9-4f5a-8f53-cb4c683f2179/job_events/"
            }
        }
      ]
   }

GET /api/v2/lcm/clusters/{id}/cacert

Gets the certificate-authority certificate that has been automatically generated for the cluster by LCM. This certificate will only be available if internode or client encryption has been enabled for the cluster, and a job has been successfully executed. If the cluster is not configured to require a certificate, or if it has not yet been created, this endpoint returns 404 not found.

Path arguments: id: A Cluster ID.

Returns a PEM encoded x509 certificate with an http content-type of application/x-x509-ca-cert. Unlike most endpoints, this does not return JSON, but a bare certificate.

Example:

 curl http://localhost:8888/api/v2/lcm/clusters/716c1c44-4cc9-4080-9025-aea0a6bafb9d/cacert

Output:

        -----BEGIN CERTIFICATE-----
        MIIDnzCCAoegAwIBAgIJAJf/lm+zpp9SMA0GCSqGSIb3DQEBCwUAMGUxFjAUBgNV
        BAMMDTEzMDA0LWNlcnQtY2wxETAPBgNVBAoMCERhdGFTdGF4MQ0wCwYDVQQLDARg
        RFNFMQswCQYDVQQGEwJVUzELMAkGA1UECAwCVFgxDzANBgNVBAcMBkF1c3RpbjAg
        Fw0xNzA5MTkyMDA5MzhaGA8yMTE3MDgyNjIwMDkzOFowZTEWMBQGA1UEAwwNMTMw
        MDQtY2VydC1jbDERMA8GA1UECgwIRGF0YVN0YXgxDTALBgNVBAsMBGBEU0UxCzAJ
        BgNVBAYTAlVTMQswCQYDVQQIDAJUWDEPMA0GA1UEBwwGQXVzdGluMIIBIjANBgkq
        hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAyVxkFjaIffA9j+W96y2yWqLpnxkkVSye
        FdTr7sEdrc/IfYoo4GhdWXUQ6eo2gMzlZKy9Ut8LOIPoIVjcLrm7Hrldhl7c//+4
        DBO0r/hXeOAysLDe9HD1icjx293X2oFFA8DV4TH/o8V58BvcYSXBZoHAaRgx4zcm
        mmKLnDuGdfTAwnfn/lbqndzmU1W5hlWua+6TqVKaS0KK0alVPXSwT2pyh1PWIfZt
        39m5YQTkxILkPBjhuy1Rmehu33rmyyDjgmTsmF9bfwtlCNBdbw59q2erBjfnWVa0
        yKdHjnicQGe67CE5gNm3Z8W5qXqQ//RDlt0v6FvOSd4B/nR422mclQIDAQABo1Aw
        TjAdBgNVHQ4EFgQUbdMkDvr8cZHxSE/lnm1AK8Y9/cgwHwYDVR0jBBgwFoAUbdMk
        Dvr8cZHxSE/lnm1AK8Y9/cgwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsFAAOC
        AQEAhOxZcVbu1TTG/Q45/9wIknElV5COj94aCo4B6qQThybO2btc65zYWgrVluWB
        VeAm/lWINgWMy+1zi66OQrKitUsWjYhdy0sEWy5CrTIIZFdSlcWSMRer5liOYg2v
        DMh+gOQRGXec/f9pRRwdg/lyyAgiW0cjwJe1gs3IdQAt+0R52L8w5gqVI8GphtGP
        t1pGtcTemlpoJIKzZ5jxhmD+ILV9/Jwnp1OUZl0DIjuYd0goA2NrkfyU9ygroTxM
        8ydBxD9zoUeEDFMhzP7mm4HJDi8muh7vS1WEdFFGwszqbPx+u1gsFCsnXLs+DjHN
        nvZDSyW09JeTrbml3zECuFiVVw==
        -----END CERTIFICATE-----

GET /api/v2/lcm/clusters/

Gets a paginated list of all Cluster records. See Paginated Results for an overview of the query string parameters that can be used.

Example:

 curl http://localhost:8888/api/v2/lcm/clusters/

Output:

    {
        "last" : 1,
        "per-page" : 50,
        "previous" : null,
        "next" : null,
        "current" : 1,
        "count": 1,
        "results": [
            {
                "type" : "cluster",
                "opsc-cluster-id" : null,
                "id" : "591ae107-2ef8-4c0f-b603-3b9f2d722d2f",
                "href" : "http://localhost:8888/api/v2/lcm/clusters/591ae107-2ef8-4c0f-b603-3b9f2d722d2f",
                "config-profile-id" : "4ff7a9ae-257c-4a6c-bfb0-b47299f39795",
                "managed" : true,
                "ssh-management-port" : 22,
                "job-status" : "COMPLETE",
                "modified-on" : "2016-06-06T17:12:00.738Z",
                "created-on" : "2016-06-02T14:33:59.700Z",
                "last-job-id" : "0370f668-3f53-478f-b29e-78d6bcc778d6",
                "related-resources" : {
                    "datacenters" : "http://localhost:8888/api/v2/lcm/clusters/591ae107-2ef8-4c0f-b603-3b9f2d722d2f/datacenters/"
                }
            }
        ]
    }

POST /api/v2/lcm/clusters/

Creates a new cluster record.

Body: A Cluster object (with no ID property).

When authentication is enabled for the configuration profile associated with the cluster, as is the case by default, it is necessary to provide old-password and new-password fields so that LCM can set a secure password on installation. For initial install, the old-password should be set to cassandra, which is the default out-of-the box password.

Returns the newly created Cluster object.

Example:

 curl -X POST \
      -d '{"name": "test-cluster-01", \
          "machine-credential-id":  "0f03dff7-1874-4c17-a823-ff79dba6e694", \
          "repository-id": "7db37bd2-c23a-4ea6-a415-e9faaeb2060f", \
          "old-password": "cassandra", \
          "new-password": "datastax", \
          "config-profile-id": "4ff7a9ae-257c-4a6c-bfb0-b47299f39795"}' \
   http://localhost:8888/api/v2/lcm/clusters/

Output:

    {
        "created-by": "system",
        "created-on": "2016-06-21T14:33:11.859Z",
        "datacenter": [],
        "type": "cluster",
        "job-status": null,
        "config-profile-id": "4ff7a9ae-257c-4a6c-bfb0-b47299f39795",
        "modified-by": "system",
        "opsc-cluster-id": null,
        "ssh-management-port": 22,
        "managed": true,
        "repository-id": "7db37bd2-c23a-4ea6-a415-e9faaeb2060f",
        "modified-on": "2016-06-21T14:33:11.859Z",
        "machine-credential-id": "0f03dff7-1874-4c17-a823-ff79dba6e694",
        "name": "test-cluster-01",
        "comment": null,
        "last-job-id": null,
        "id": "108f74ab-0c5c-4bf7-8527-695e3e630e1a",
        "href": "http://localhost:8888/api/v2/lcm/clusters/108f74ab-0c5c-4bf7-8527-695e3e630e1a",
        "related-resources": {"datacenters": "http://localhost:8888/api/v2/lcm/clusters/108f74ab-0c5c-4bf7-8527-695e3e630e1a/datacenters/"}
    }

PUT /api/v2/lcm/clusters/{id}

Updates an existing cluster record by ID. The cluster password can be changed by including old-password and new-password in the request body. The password change does not take effect until the next configure or upgrade job.

Path arguments: id: A Cluster ID.

Returns the updated Cluster object.

Example:

 curl -X PUT -d '{"comment": "This is my new comment."}'    http://localhost:8888/api/v2/lcm/clusters/108f74ab-0c5c-4bf7-8527-695e3e630e1a

Output:

    {
        "id": "108f74ab-0c5c-4bf7-8527-695e3e630e1a",
        "name": "test-cluster-01",
        "comment": "This is my new comment.",
        "repository-id": "7db37bd2-c23a-4ea6-a415-e9faaeb2060f",
        "machine-credential-id": "0f03dff7-1874-4c17-a823-ff79dba6e694",
        "config-profile-id": "4ff7a9ae-257c-4a6c-bfb0-b47299f39795",
        "datacenter": [],
        "type": "cluster",
        "job-status": null,
        "related-resources": {
            "datacenters": "http://localhost:8888/api/v2/lcm/clusters/108f74ab-0c5c-4bf7-8527-695e3e630e1a/datacenters/"
        },
        "modified-by": "system",
        "created-on": "2016-06-21T14:33:11.859Z",
        "opsc-cluster-id": null,
        "ssh-management-port": 22,
        "managed": true,
        "modified-on": "2016-06-21T15:10:06.635Z",
        "last-job-id": null,
        "href": "http://localhost:8888/api/v2/lcm/clusters/108f74ab-0c5c-4bf7-8527-695e3e630e1a",
        "created-by": "system"
    }

DELETE /api/v2/lcm/clusters/{id}

Deletes an existing cluster record by ID. This is subject to foreign key constraint violations.

Path arguments: id: A Cluster ID.

Returns the IDs of the deleted objects.

Example:

 curl -X DELETE http://localhost:8888/api/v2/lcm/clusters/108f74ab-0c5c-4bf7-8527-695e3e630e1a

Output:

    {"deleted": {"cluster": ["108f74ab-0c5c-4bf7-8527-695e3e630e1a"]}}

General Inquiries: +1 (650) 389-6000 info@datastax.com

© DataStax | Privacy policy | Terms of use

DataStax, Titan, and TitanDB are registered trademarks of DataStax, Inc. and its subsidiaries in the United States and/or other countries.

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries.

Kubernetes is the registered trademark of the Linux Foundation.

landing_page landingpage