Debian Codegraph @

doc/source/cli/freezer.rst

raw
1 ================================
2 :program:`freezer` CLI man page
3 ================================
4
5 .. program:: freezer
6 .. highlight:: bash
7
8 SYNOPSIS
9 ========
10
11 :program:`freezer` [options] <command> [command-options]
12
13 :program:`freezer help`
14
15 :program:`freezer help` <command>
16
17
18 DESCRIPTION
19 ===========
20
21 The :program:`freezer` command line utility interacts with OpenStack Backup, Restore, and DR service (Freezer).
22
23 In order to use the CLI, you must provide your OpenStack username, password,
24 project (historically called tenant), and auth endpoint. You can use
25 configuration options ``--os-username``, ``--os-password``, ``--os-project-id``,
26 and ``--os-auth-url`` or set corresponding environment variables::
27
28 export OS_USERNAME=user
29 export OS_PASSWORD=pass
30 export OS_PROJECT_ID=c373706f891f48019483f8bd6503c54b
31 export OS_AUTH_URL=http://auth.example.com:5000/v2.0
32
33 The command line tool will attempt to reauthenticate using provided credentials
34 for every request. You can override this behavior by manually supplying an auth
35 token using ``--os-backup-url`` and ``--os-auth-token`` or by setting
36 corresponding environment variables::
37
38 export OS_IMAGE_URL=http://freezer.example.org:9090/
39 export OS_AUTH_TOKEN=3bdc4d3a03f44e3d8377fa247b0ad155
40
41 You can select an API version to use by ``--os-backup-api-version`` option or by
42 setting corresponding environment variable::
43
44 export OS_BACKUP_API_VERSION=1
45
46 Default Freezer API used is v2.
47
48 OPTIONS
49 =======
50
51 To get a list of available commands and options run::
52
53 freezer help
54
55 To get usage and options of a command::
56
57 freezer help <command>
58
59
60 EXAMPLES
61 ========
62
63 Get information about job-create command::
64
65 freezer help job-create
66
67 See available actions::
68
69 freezer job-list
70
71 Create new job::
72
73 freezer job-create --file /root/action-local-nova-with-vol.json --client
74 ubuntu_c89bd80e25da4407a12bfc73daa47052
75
76 Describe a specific image::
77
78 freezer job-show <Job-ID>
79
80 BUGS
81 ====
82
83 Use the master OpenStack bug tracker,available at:
84 https://storyboard.openstack.org/#!/project/openstack/freezer.