Adding a Swift Command Line Interface (CLI) backup location

About this task

Add a Swift CLI backup location.

The Backup Service requires control over the data and structure of its destination locations. The backup destinations must be dedicated for use only by OpsCenter. Any additional directories or files in those destinations can prevent the Backup Service from properly conducting a Backup or Restore operation.


Install a Swift CLI container to store your backup data.


  1. Locate the cluster_name.conf file to edit. The location of this file depends on the type of installation:

    • Package installations: /etc/opscenter/clusters/cluster_name.conf

    • Tarball installations: install_location/conf/clusters/cluster_name.conf

  2. To enable Swift CLI for backup, add use_swift_cli to cluster_name.conf:

    use_swift_cli = True

    Backing up to Swift is currently a Labs feature.

  3. Optional: To set a delay before allowing the Openstack Swift backup to be verified, using the default delay, add swift_cli_sync_status_delay_seconds to cluster_name.conf.

    swift_cli_sync_status_delay_seconds = N (1)
    1 The delay default is 10 seconds. Add = N to the delay statement to change the default value, where N is a numeric value of your choosing.
  4. Install the Swift client on each DSE node of the monitored DSE cluster:

    $ pip install python-swiftclient==3.7.0
  5. Restart opscenterd.

  6. Access the Create (or Edit) Backup dialog.

  7. In the Create or Edit Backup dialog, under Location, click +Add Location.

    The Add Location dialog appears.

  8. Select OpenStack Swift as the backup Location.

  9. Select the Credentials Source. Provide the required credential information.

    Credentials Source Credential Fields

    User-Supplied Credentials

    • Container Name

    • Sub Folder (optional)

    • Authentication Endpoint

    • User

    • Key

    Detect Swift Enviromental Variables

    • Container Name

    • Sub Folder (optional)

    If any of your credentials are incorrect, your location will not validate.

  10. Click Save Location.

    The newly added Open location displays in the Location pane of the Create or Edit Backup dialog.

    Click the edit icon to edit a location and its retention policy if applicable. Click the delete icon to delete a location. The On Server location cannot be deleted.

  11. Optional: For scheduled backups, indicate how long the snapshot data should be retained by selecting a Retention Policy. Retain All (default) saves the snapshot data indefinitely. Or, define a set period of time. After the snapshot data is older than the time set in Retention Policy, the snapshot data is deleted.

    DataStax strongly recommends setting a retention policy to periodically remove backups. This practice helps to avoid long-term performance issues caused by an excessive number of backups.

  12. Click Save Location.

    The newly added OpenStack Swift location displays in the Location pane of the Create or Edit Backup dialog.

  13. Click Save Backup or Create Backup as applicable.

Was this helpful?

Give Feedback

How can we improve the documentation?

© 2024 DataStax | Privacy policy | Terms of use

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.

General Inquiries: +1 (650) 389-6000,