freezer CLI man page


freezer [options] <command> [command-options]

freezer help

freezer help <command>


The freezer command line utility interacts with OpenStack Backup, Restore, and DR service (Freezer).

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

export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_PROJECT_ID=c373706f891f48019483f8bd6503c54b
export OS_AUTH_URL=

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

export OS_IMAGE_URL=
export OS_AUTH_TOKEN=3bdc4d3a03f44e3d8377fa247b0ad155

You can select an API version to use by --os-backup-api-version option or by setting corresponding environment variable:


Default Freezer API used is v2.


To get a list of available commands and options run:

freezer help

To get usage and options of a command:

freezer help <command>


Get information about job-create command:

freezer help job-create

See available actions:

freezer job-list

Create new job:

freezer job-create  --file /root/action-local-nova-with-vol.json --client

Describe a specific image:

freezer job-show <Job-ID>


Use the master OpenStack bug tracker,available at:!/project/openstack/freezer.