data-protection

Use the data-protection plug-in to backup, restore, and migrate cluster data.

Installation

tanzu plugin install data-protection --target mission-control 

Usage

tanzu mission-control data-protection [command]

Commands

  backup            The Kubernetes cluster state related to backup (API objects and associated volume state)
  backup-location   A target location for backups
  disable           Disable dataprotection
  enable            Enable data-protection
  update            Update data-protection
  restore           The application of resources from a backup to a target Kubernetes cluster
  schedule          A pre-scheduled or periodic Backup that should be run
  snapshot-location The snapshot location assigned to a cluster

backup

The Kubernetes cluster state related to backup (API objects and associated volume state).

Usage

tanzu mission-control data-protection backup [command]

Commands

  create      Create a backup object
  delete      Delete a backup
  get         Retrieve a backup object
  list        Return a list of backups
  template    Backup template

backup create

Create a backup object.

Usage

tanzu mission-control data-protection backup create [flags]

Flags

  -v, --data-values-file string   data values file to use
  -f, --file string               resource file from which to create a backup
  -h, --help                      help for create
  -t, --template string           template to use (default "default")

backup delete

Delete a backup.

Usage

tanzu mission-control data-protection backup delete BACKUP_NAME [flags]

Flags

      --cluster-name string              name of the cluster
  -m, --management-cluster-name string   name of the management cluster
  -p, --provisioner-name string          name of the provisioner

backup get

Retrieve a backup object.

Usage

tanzu mission-control data-protection backup get BACKUP_NAME [flags]

Flags

      --cluster-name string              name of the cluster
  -m, --management-cluster-name string   name of the management cluster
  -o, --output string                    output format (yaml | json) (default "yaml")
  -p, --provisioner-name string          name of the provisioner

backup list

Return a list of backups.

Usage

tanzu mission-control data-protection backup list [flags]

Flags

      --cluster-name string              scope search to the specified cluster_name
  -m, --management-cluster-name string   scope search to the specified management cluster
      --max-size uint                    number of records to return
      --name string                      scope search to the specified name
      --offset uint                      offset at which to start returning records
  -o, --output string                    output format (yaml|json)
  -p, --provisioner-name string          scope search to the specified provisioner

backup template

Backup template.

Usage

tanzu mission-control data-protection backup template [command]

Commands

  get         Get template for backup
  list        List templates for backup

backup template get

Get template for backup.

Usage

tanzu mission-control data-protection backup template get TEMPLATE_NAME [flags]

backup template list

List templates for backup.

Usage

tanzu mission-control data-protection backup template list [flags]

backup-location

A target location for backups.

Usage

tanzu mission-control data-protection backup-location [command]

Commands

  create      Create a backup object
  delete      Delete a backuplocation
  get         Retrieve a backup-location object
  list        Return a list of backup-locations
  template    Backup location template
  update      Update (overwrite) a backuplocation

backup-location create

Create a backup location object.

Usage

tanzu mission-control data-protection backup-location create [flags]

Flags

  -v, --data-values-file string   data values file to use
      --dry-run                   create the data model only, do not apply to server
  -f, --file string               resource file from which to create a backup location
  -h, --help                      help for create
  -t, --template string           template to use (default "default")

backup-location delete

Delete a backup location.

Usage

tanzu mission-control data-protection backup-location delete BACKUP_LOCATION_NAME [flags]

backup-location get

Retrieve a backup location object.

Usage

tanzu mission-control data-protection backup-location get BACKUP_LOCATION_NAME [flags]

Flags

      --cluster-name string              name of the cluster to get cluster level backup location details
  -m, --management-cluster-name string   name of the management cluster
  -o, --output string                    output format (yaml | json) (default "yaml")
  -p, --provisioner-name string          name of the provisioner

backup-location list

Return a list of backup-locations.

Usage

tanzu mission-control data-protection backup-location list [flags]

Flags

      --assigned-group-name string       filter backup locations by an assigned group name (org scope flag)
      --cluster-name string              scope search to the specified cluster (cluster scope flag)
      --credential-name string           filter backup locations by a credential name (org scope flag)
  -m, --management-cluster-name string   scope search to the specified management cluster
      --max-size uint                    number of records to return
      --name string                      scope search to the specified name
      --offset uint                      offset at which to start returning records
  -o, --output string                    output format (yaml|json)
  -p, --provisioner-name string          scope search to the specified provisioner
  -s, --scope string                     select scope (cluster|org)

backup-location template

Backup location template.

Usage

tanzu mission-control data-protection backup-location template [command]

Commands

  get         Get Template for backup location
  list        List Templates for backup location

backup-location template get

Get template for backup location.

Usage

tanzu mission-control data-protection backup-location template get TEMPLATE_NAME [flags]

backup-location template list

List templates for backup location.

Usage

tanzu mission-control data-protection backup-location template list [flags]

backup-location update

Update (overwrite) a backup location.

Usage

tanzu mission-control data-protection backup-location update [flags]

Flags

  -v, --data-values-file string   data values file to use
      --dry-run                   create the data model only, do not apply to server
  -f, --file string               resource file from which to update the backup location
  -t, --template string           template to use (default "default")

disable

Disable data protection.

Usage

tanzu mission-control data-protection disable [flags]

Flags

      --cluster-name string              name of the cluster
  -g, --cluster-group-name string        name of the cluster group
      --delete-backups                   delete all backup files associated with this cluster from the backup storage location
      --force-delete                     forcefully delete data protection from cluster. Only applicable for cluster group scope.
  -m, --management-cluster-name string   name of the management cluster
  -p, --provisioner-name string          name of the provisioner
  -s, --scope string                     scope for operation, accepts 'cluster' and 'clustergroup', default: 'cluster'

enable

Enable data protection.

Usage

  tanzu mission-control data-protection enable [flags]

Flags

 -v, --data-values-file string   data values file to use
 -f, --file string               resource file from which to create a dataprotection
 -h, --help                      help for enable
 -t, --template string           template to use (default "default")
 -s, --scope string              scope for operation, accepts 'cluster' and 'clustergroup', default: 'cluster'

update

Update data protection.

Usage

  tanzu mission-control data-protection update [flags]

Flags

  -v, --data-values-file string   data values file to use
  -f, --file string               resource file from which to update dataprotection
  -h, --help                      help for update
  -t, --template string           template to use (default "default")
  -s, --scope string              scope for operation, accepts 'cluster' and 'clustergroup', default: 'cluster'

restore

The application of resources from a backup to a target Kubernetes cluster.

Usage

  tanzu mission-control data-protection restore [command]

Commands

  create      Create a restore object
  delete      Delete a restore
  get         Retrieve a restore object
  list        Return a list of restores
  template    Restore template

restore create

Create a restore object.

Usage

  tanzu mission-control data-protection restore create [flags]

Flags

  -v, --data-values-file string   data values file to use
  -f, --file string               resource file from which to create a restore
  -h, --help                      help for create
  -t, --template string           template to use (default "default")

restore delete

Delete a restore.

Usage

  tanzu mission-control data-protection restore delete RESTORE_NAME [flags]

Flags

      --cluster-name string              name of the cluster
  -m, --management-cluster-name string   name of the management cluster
  -p, --provisioner-name string          name of the provisioner

restore get

Retrieve a restore object.

Usage

  tanzu mission-control data-protection restore get RESTORE_NAME [flags]

Flags

      --cluster-name string              name of the cluster
  -m, --management-cluster-name string   name of the management cluster
  -o, --output string                    output format (yaml | json) (default "yaml")
  -p, --provisioner-name string          name of the provisioner

restore list

Return a list of restores.

Usage

  tanzu mission-control data-protection restore list [flags]

Flags

      --cluster-name string              scope search to the specified cluster name
  -h, --help                             help for list
  -m, --management-cluster-name string   scope search to the specified management cluster
      --max-size uint                    number of records to return
      --name string                      scope search to the specified name
      --offset uint                      offset at which to start returning records
  -o, --output string                    output format (yaml|json)
  -p, --provisioner-name string          scope search to the specified provisioner

restore template

Restore template.

Usage

tanzu mission-control data-protection restore template [command]

Commands

  get         Get template for restore
  list        List templates for restore

restore template get

Get template for restore.

Usage

tanzu mission-control data-protection restore template get TEMPLATE_NAME [flags]

restore template list

List templates for restore.

Usage

tanzu mission-control data-protection restore template list [flags]

schedule

A pre-scheduled or periodic backup that should be run.

Usage

  tanzu mission-control data-protection schedule [command]

Commands

  create      Create a schedule object
  delete      Delete a schedule
  get         Retrieve a schedule object
  list        Return a list of schedules
  template    Schedule template
  update      Update a schedule object

schedule create

Create a schedule object.

Usage

tanzu mission-control data-protection schedule create [flags]

Flags

-v, --data-values-file string   data values file to use
-f, --file string               resource file from which to create a schedule
-h, --help                      help for create
-s, --scope string              scope for operation, accepts 'cluster' and 'clustergroup', default: 'cluster'
-t, --template string           template to use (default "default")

schedule update

Update a schedule object.

Usage

tanzu mission-control data-protection schedule update [flags]

Flags

-v, --data-values-file string   data values file to use
-f, --file string               resource file from which to update a schedule
-h, --help                      help for update
-s, --scope string              scope for operation, accepts 'cluster' and 'clustergroup', default: 'cluster'
-t, --template string           template to use (default "default")

schedule delete

Delete a schedule.

Usage

  tanzu mission-control data-protection schedule delete SCHEDULE_NAME [flags]

Flags

      --cluster-group-name string        name of the cluster group (clustergroup scope only)
      --cluster-name string              name of the cluster (cluster scope only)
  -h, --help                             help for delete
  -m, --management-cluster-name string   name of the management cluster (cluster scope only)
  -p, --provisioner-name string          name of the provisioner (cluster scope only)
  -s, --scope string                     scope for operation, accepts 'cluster' and 'clustergroup', default: 'cluster'

schedule get

Retrieve a schedule object.

Usage

  tanzu mission-control data-protection schedule get SCHEDULE_NAME [flags]

Flags

      --cluster-group-name string        name of the cluster group (clustergroup scope only)
      --cluster-name string              name of the cluster (cluster scope only)
  -h, --help                             help for get
  -m, --management-cluster-name string   name of the management cluster (cluster scope only)
  -o, --output string                    output format (yaml | json) (default "yaml")
  -p, --provisioner-name string          name of the provisioner (cluster scope only)
  -s, --scope string                     scope for operation, accepts 'cluster' and 'clustergroup', default: 'cluster'

schedule list

Return a list of schedules.

Usage

  tanzu mission-control data-protection schedule list [flags]

Flags

      --cluster-group-name string        name of the cluster group (clustergroup scope only)
      --cluster-name string              scope search to the specified cluster name
  -h, --help                             help for list
  -m, --management-cluster-name string   scope search to the specified management cluster
      --max-size uint                    number of records to return
      --name string                      scope search to the specified name
      --offset uint                      offset at which to start returning records
  -o, --output string                    output format (yaml|json)
  -p, --provisioner-name string          scope search to the specified provisioner
  -s, --scope string                     scope for operation, accepts 'cluster' and 'clustergroup', default: 'cluster'

schedule template

Schedule template.

Usage

tanzu mission-control data-protection schedule template [command]

Commands

  get         Get template for schedule
  list        List templates for schedule

schedule template get

Get template for schedule.

Usage

tanzu mission-control data-protection schedule template get TEMPLATE_NAME [flags]

Flags

  -h, --help           help for get
  -s, --scope string   scope for operation, accepts 'cluster' and 'clustergroup', default: 'cluster'

schedule template list

List templates for schedule.

Usage

tanzu mission-control data-protection schedule template list [flags]

Flags

  -h, --help           help for get
  -s, --scope string   scope for operation, accepts 'cluster' and 'clustergroup', default: 'cluster'

snapshot-location

The snapshot location assigned to a cluster.

Usage

  tanzu mission-control data-protection snapshot-location [command]

Commands

  get         Retrieve a snapshot-location object
  list        Return a list of snapshotlocations

snapshot-location get

Retrieve a snapshot-location object.

Usage

  tanzu mission-control data-protection snapshot-location get SNAPSHOT_LOCATION_NAME [flags]

Flags

      --cluster-name string              name of the cluster
  -m, --management-cluster-name string   name of the management cluster
  -o, --output string                    output format (yaml | json) (default "yaml")
  -p, --provisioner-name string          name of the provisioner

snapshot-location list

Return a list of snapshot locations.

Usage

  tanzu mission-control data-protection snapshot-location list [flags]

Flags

      --cluster-name string              scope search to the specified cluster name
  -m, --management-cluster-name string   scope search to the specified management cluster
      --max-size uint                    number of records to return
      --name string                      scope search to the specified name
      --offset uint                      offset at which to start returning records
  -o, --output string                    output format (yaml|json)
  -p, --provisioner-name string          scope search to the specified provisioner