## Reference

this page last updated: 2020-01-09 12:24:48

The freezer Shell Utility

The freezer shell utility interacts with OpenStack Freezer API from the command line. It supports the entirety of the OpenStack Freezer API.

You’ll need to provide freezer with your OpenStack Keystone user information. You can do this with the –os-username, –os-password, –os-project-name (–os-project-id), –os-project-domain-name (–os-project-domain-id) and –os-user-domain-name (–os-user-domain-id) options, but it’s easier to just set them as environment variables by setting some environment variables:

`OS_USERNAME`

  Your OpenStack Keystone user name.

`OS_PASSWORD`

  Your password.

`OS_PROJECT_NAME`

  The name of project for work.

`OS_PROJECT_ID`

  The ID of project for work.

`OS_PROJECT_DOMAIN_NAME`

  The name of domain containing the project.

`OS_PROJECT_DOMAIN_ID`

  The ID of domain containing the project.

`OS_USER_DOMAIN_NAME`

  The user’s domain name.

`OS_USER_DOMAIN_ID`

  The user’s domain ID.

`OS_AUTH_URL`

  The OpenStack Keystone endpoint URL.

`OS_BACKUP_API_VERSION`

  The OpenStack freezer API version.

`OS_REGION_NAME`

  The Keystone region name. Defaults to the first region if multiple regions are available.

For example, in Bash you’d use:

    export OS_USERNAME=yourname
    export OS_PASSWORD=yadayadayada
    export OS_PROJECT_NAME=myproject
    export OS_PROJECT_DOMAIN_NAME=default
    export OS_USER_DOMAIN_NAME=default
    export OS_AUTH_URL=http://<url-to-openstack-keystone>/identity
    export OS_BACKUP_API_VERSION=2

From there, all shell commands take the form:

    freezer <command> [arguments...]

Run freezer help to get a full list of all possible commands, and run freezer help <command> to get detailed help for that command.

# Reference

For more information, see the reference:

- freezer CLI man page
  - SYNOPSIS
  - DESCRIPTION
  - OPTIONS
  - EXAMPLES
  - BUGS

this page last updated: 2020-01-09 12:24:48

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 questions?