IBM Cloud Backup Recovery CLI Plug-in

This CLI plug-in for IBM Cloud Backup and Recovery enables customers to leverage a managed service that provides backup solutions for various customer workloads running on IBM Cloud.

Summary

This repository contains the source for the Backup Recovery CLI plug-in.

Requirements

• Have an IBM Cloud Account.
• Have IBM Cloud CLI installed.

Getting Started

Get started with IBM Cloud Backup and Recovery documentation.

Installation

ibmcloud plugin install backup-recovery

Authentication

There are three ways to provide credentials to authenticate the CLI plugin:

1. Export them as environment variables.

2. Store them in a credentials file Properties must have the format <service-name>_<property-key>. For example, BACKUP_RECOVERY_URL. See Define Configuration Properties for more info. If using a credentials file, it must be called ibm-credentials.env or the name must be provided with an environment variable called IBM_CREDENTIALS_FILE. See Complete Configuration-loading Process for more information about how the credentials file is located.

3. Login to IBM Cloud on the command line - ibmcloud login. The CLI plugin will read the IAM access token stored in the CLI context and will refresh it if it expires.

Commands

backup-recovery

NAME:
  backup-recovery - REST API used to configure protection source.

USAGE:
  ibmcloud backup-recovery [command] [options]

COMMANDS:
  access-token-create                Create access token.
  access-token-generate              Generate an Access Token.
  agent-download                     Download agent.
  agent-upgrade-task                 Commands for AgentUpgradeTask resource.
  batch-vault-failover-status        Get the status of latest failover for the all specified Backup and Recovery instances. Here the Backup and Recovery instance refers to the vault.
  batch-vault-recovery-scan-status   Get the status of latest recovery scan for the all specified Backup and Recovery instances. Here the Backup and Recovery instance refers to the vault.
  config                             Control persistent configuration.
  connector-agent                    Commands for ConnectorAgent resource.
  connector-metadata-get             Get information about the available connectors.
  data-source-connection             Commands for DataSourceConnection resource.
  data-source-connector              Commands for DataSourceConnector resource.
  data-source-connector-logs         Lists the data source connector logs.
  data-source-connector-register     Register a data source connector.
  data-source-connector-status       Lists the data source connector status.
  download-recovery-create           Create a download files and folders recovery.
  indexed-file-download              Download an indexed file.
  indexed-objects-search             List indexed objects.
  initiate-vault-failover            Initiate a failover for the specified Backup and Recovery instance. Here the Backup and Recovery instance refers to the vault.
  management-console                 Commands for Backup Recovery Management resource.
  meta-info-create                   Construct meta info for any workflow from object snapshot and some other information.
  object-snapshots-list              List the snapshots for a given object.
  objects-search                     List objects.
  progress-monitors-status           Gets the progress and status of tasks from Pulse.
  protected-objects-search           List protected objects.
  protection-group                   Commands for ProtectionGroup resource.
  protection-group-run               Commands for ProtectionGroupRun resource.
  protection-policy                  Commands for ProtectionPolicy resource.
  protection-source                  Commands for ProtectionSource resource.
  provider-instances                 List Provider Instances.
  recovery                           Commands for Recovery resource.
  restore-points                     List restore points in a given time range.
  user-update                        Update user.
  users                              Get users.
  vault-recovery-scan                Initiate a recovery scan on the specified Backup and Recovery instance. Here the Backup and Recovery instance refers to the vault.



OPTIONS:
  -h, --help      Show help
  -q, --quiet     Suppresses verbose messages.
  -v, --version   Version of the plugin.

Use "ibmcloud backup-recovery service-command --help" for more information about a command.

Trace logging

To see detailed HTTP information (full requests and responses) in the CLI plugin output, enable tracing using one of the following methods. The setting can be "false" (default, turns off tracing), "true" (turns on tracing, logs are sent to stderr), or a path to a file (turns on tracing, logs are sent to the file).

1. Set the global "trace" setting with the config command: ibmcloud config trace true

2. Set the global "trace" environment variable: export IBMCLOUD_TRACE=/path/to/trace.log

Note that both of these methods turn on tracing globally for all ibmcloud usage.

License

This IBM CLI Plugin project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.