# <no title>

Command-line Tool Reference

In order to use the CLI, you must provide your OpenStack username, password, tenant, and auth endpoint. Use the corresponding configuration options (`--os-username`, `--os-password`, `--os-project-id`, and `--os-auth-url`) or set them in environment variables:

    export OS_USERNAME=user
    export OS_PASSWORD=pass
    export OS_PROJECT_ID=c373706f891f48019483f8bd6503c54b
    export OS_AUTH_URL=http://auth.example.com:5000/v2.0

The command line tool will attempt to reauthenticate using your provided credentials for every request. You can override this behavior by manually supplying an auth token using `--os-backup-url` and `--os-auth-token`. You can alternatively set these environment variables:

    export OS_BACKUP_URL=http://freezer.example.org:9090/
    export OS_AUTH_TOKEN=3bdc4d3a03f44e3d8377fa247b0ad155

Once you’ve configured your authentication parameters, you can run `freezer help` to see a complete listing of available commands.

- Backup, Restore, and Disaster Recovery service (freezer) command-line client
  - freezer usage
  - freezer optional arguments
    - freezer action-create
    - freezer action-delete
    - freezer action-list
    - freezer action-show
    - freezer action-update
    - freezer backup-delete
    - freezer backup-list
    - freezer backup-show
    - freezer client-delete
    - freezer client-list
    - freezer client-register
    - freezer client-show
    - freezer job-abort
    - freezer job-create
    - freezer job-delete
    - freezer job-get
    - freezer job-list
    - freezer job-show
    - freezer job-start
    - freezer job-stop
    - freezer job-update
    - freezer session-add-job
    - freezer session-create
    - freezer session-delete
    - freezer session-list
    - freezer session-remove-job
    - freezer session-show
    - freezer session-start
    - freezer session-update
- freezer CLI man page
  - SYNOPSIS
  - DESCRIPTION
  - OPTIONS
  - EXAMPLES
  - BUGS

this page last updated: 2024-12-19 09:48:55

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug